c3f43d8b61
- Add 60 new agents across all 10 categories (75 -> 135) - Add 95 new plugins with command files (25 -> 120) - Update all agents to use model: opus - Update README with complete plugin/agent tables - Update marketplace.json with all 120 plugins
1.5 KiB
1.5 KiB
/generate-api-ref - Generate API Reference
Generate API reference documentation from source code and route definitions.
Steps
- Detect the API framework: Express, FastAPI, Django REST, Spring Boot, Gin, etc.
- Scan route definitions to find all API endpoints
- For each endpoint, extract: HTTP method, path, middleware, handler function
- Parse handler functions to identify request parameters (path, query, body, headers)
- Extract request/response schemas from TypeScript types, Pydantic models, or JSDoc
- Identify authentication requirements from middleware chains
- Find example request/response pairs from test files or inline documentation
- Detect rate limiting, pagination, and caching configurations
- Generate markdown documentation for each endpoint with: method, path, description, parameters, request body, response, errors
- Group endpoints by resource or router module
- Add a table of contents and overview section
- Save documentation to docs/api-reference.md or the specified output path
Rules
- Include all HTTP methods (GET, POST, PUT, PATCH, DELETE) for each resource
- Document error responses (400, 401, 403, 404, 500) with example payloads
- Use the actual TypeScript/Python types, not simplified versions
- Include authentication requirements for each endpoint
- Show curl examples for at least the primary endpoints
- Do not document internal or health-check endpoints unless requested
- Keep parameter descriptions concise but include type and required status