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.
インストール方法を見るインストールする前に、エージェントに与えられる指示の中身を確認できます。
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 documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.
日本語の概要は準備中です。原文の説明を表示しています。
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.
日本語の概要は準備中です。原文の説明を表示しています。
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.
日本語の概要は準備中です。原文の説明を表示しています。