api-documentation-generator

# 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):** 1. **OpenAPI/Swagger specifications** (`.yaml`, `.yml`, `.json`) - Look in: root directory, `/docs`, `/api`, `/spec`, `/openapi` - Files named: `openapi.yaml`, `swagger.json`, `api-spec.yaml`, etc. 2. **Code files with docstrings/comments** - Python: Flask/FastAPI route decorators, docstrings - JavaScript/TypeScript: Express routes, JSDoc comments - Java: Spring annotations, Javadoc - Go: HTTP handler comments - Ruby: Rails routes, YARD comments 3. **Existing documentation** - Markdown files in `/docs`, `/documentation`, `/api-docs` - README files with API sections - Wiki pages or doc site content 4. **Configuration files** - `routes.rb`, `urls.py`, `routes.js` - API gateway configurations **Discovery approach:** ```bash # Find OpenAPI specs find . -name "openapi.*" -o -name "swagger.*" -o -name "*api-spec*" # Find API route definitions grep -r "@app.route\|@router\|app.get\|app.post" --include="*.py" --include="*.js" # Find documentation find . -path "*/docs/*" -name "*.md" -o -path "*/api/*" -name "*.md" ``` ### 2. Extract API I...