Swagger UI

Swagger UI renders OpenAPI (formerly Swagger) specifications as interactive API documentation. Paste or host your OpenAPI JSON/YAML spec and explore endpoints, try live requests, and inspect responses — all from your browser.

What You Can Do After Deployment

Visit your domain to see the default Petstore API demo. To use your own API spec, set the SWAGGER_JSON_URL environment variable.

Interactive documentation: Browse API endpoints organized by tags. Expand any operation to see parameters, request bodies, and response schemas.

Try it out: Execute real API requests directly from the documentation. Fill in parameters, set headers, and see live responses.

Multiple specs: Switch between different API specifications using the URL bar at the top of the page.

Authentication: Configure API keys, OAuth 2.0, or Bearer tokens to test authenticated endpoints.

Deep linking: Share links to specific operations. URLs update as you navigate.

Configuration

• Custom API spec: Set SWAGGER_JSON_URL in Zeabur's Service > Variables to point to your OpenAPI spec URL (e.g., https://api.example.com/openapi.json).
• Local spec file: Mount a spec file to /usr/share/nginx/html/swagger.json and set SWAGGER_JSON to /swagger.json.
• Base URL: Set BASE_URL to serve Swagger UI at a subpath (e.g., /docs).

License

Apache-2.0 — GitHub