Documentation
README
API Documentation Generator
Overview
Analyze a repository to extract and generate comprehensive API documentation, including endpoints, request/response schemas, authentication, and usage examples organized in a clear, multi-file structure.
Workflow
1. Discover API Information Sources
Scan the repository to identify all sources of API information:
Primary sources (in priority order):
- OpenAPI/Swagger specifications (
.yaml,.yml,.json)- Look in: root directory,
/docs,/api,/spec,/openapi - Files named:
openapi.yaml,swagger.json,api-spec.yaml, etc.
- Look in: root directory,
This is the opening of the README. Read the full README on GitHub.