English | 繁體中文

OpenAPI specification and local preview guide for the DottedSign Self-Host deployment.

Main OpenAPI file:

openapi/self_hosted.yml

Paths and components are located in openapi/paths/ and openapi/components/ respectively.

Two preview options are available — choose based on your needs:

• Redoc
• Swagger UI (watcher)

npx redoc-cli serve openapi/self_hosted.yml

Default address:

http://localhost:8080

npx -y swagger-ui-watcher openapi/self_hosted.yml --port 8080

Default address:

http://127.0.0.1:8080

Any file changes under openapi/ will automatically refresh the page. If the document does not conform to the OpenAPI specification, an Errors block will appear at the top of the page indicating what needs to be fixed.

Bundle into a single HTML file:

npx redoc-cli bundle openapi/self_hosted.yml -o redoc-static.html

Output file:

redoc-static.html