generate-swagger-docs

To auto-generate OpenAPI documentation, scan your codebase to discover API endpoints and compile a swagger.json file. This process detects routes across major web frameworks and outputs an OpenAPI 3.0 specification along with a self-contained HTML viewer.

Swagger generation works with FastAPI, Django, Express, NestJS, Rails, and Go frameworks. The scanner analyzes repositories across these major web frameworks and languages to automatically detect API endpoints and produce OpenAPI specs.

To generate swagger.json and HTML docs, you need an OpenAI API key, the apimesh tool, and a repository to scan. You run the generate-with-key.sh script with your key to automate endpoint discovery and compile the documentation.

Automated API documentation generation works with both public and private repositories. You can integrate the scanning and OpenAPI spec generation process directly into your CI/CD workflows to continuously update your swagger.json and HTML docs.

The best way to create an interactive HTML viewer is to scan your codebase to detect endpoints and compile a self-contained apimesh-docs.html file. This approach automatically generates a standalone interactive documentation viewer from your discovered routes.