Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.
中文简介正在准备中。当前显示原文说明。
查看安装方法安装前可以查看交给 AI 代理的指令内容。
Generate comprehensive API documentation from source code.
For common documentation patterns, see PATTERNS.md.
See STANDARDS.md for our documentation conventions.
Look for:
For each endpoint, extract:
Use the template in templates/endpoint.md for consistent formatting.
Generate an index of all endpoints with the template in templates/index.md.
Generate markdown documentation suitable for README or docs site.
If requested, generate OpenAPI 3.0 spec. See templates/openapi.yaml for structure.
See EXAMPLES.md for sample inputs and outputs.
To auto-detect routes in common frameworks:
python scripts/detect_routes.py <source_directory>
To validate generated OpenAPI spec:
./scripts/validate_openapi.sh <spec_file>
还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
API design patterns and conventions for this project. Covers RESTful URL naming, response format standards, error handling, and authentication requirements. Use when writing or reviewing API endpoints, designing new APIs, or making decisions about request/response formats.
中文简介正在准备中。当前显示原文说明。
Generate API endpoint code and documentation from specifications. Use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs, or produce OpenAPI/Swagger specs from code.
中文简介正在准备中。当前显示原文说明。
Generate API endpoint documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.
中文简介正在准备中。当前显示原文说明。
Perform a comprehensive code health check on a directory. Use when the user asks to analyze code quality, find issues, or get a health report.
中文简介正在准备中。当前显示原文说明。
Review code for quality, security, and best practices. Use when the user asks for code review, wants feedback on their code, mentions reviewing changes, or asks about code quality.
中文简介正在准备中。当前显示原文说明。
Generate an interactive tree visualization of your codebase. Use when exploring a new repo or understanding project structure.
中文简介正在准备中。当前显示原文说明。