sovereign-api-docs-generator
bởi ryudi84
Web & Frontend DevelopmentTóm tắt
Auto-generates comprehensive API docs from code.
Mô tả
Kỹ năng này làm gì
Generates API documentation from code descriptions, covering REST, GraphQL, and WebSocket endpoints. Produces OpenAPI/Swagger-compatible markdown with parameter tables, JSON request/response examples, and code samples in curl, JavaScript fetch, and Python requests.
Covers REST, GraphQL, and WebSocket in a single pass and outputs OpenAPI-compatible format, removing the need to manually author specs across multiple tools.
Khi nào nên dùng
- Documenting a new REST API before releasing it to external developers
- Generating curl and fetch examples for undocumented endpoints
- Creating OpenAPI specs from a legacy codebase
- Adding request and response schemas to a GraphQL API
- Producing auth and rate limit docs for an internal service
Quy trình ví dụ
User asks: Document the POST /users endpoint with JWT auth and a JSON body
- 1
Identifies method (POST), path (/users), and writes a plain-language description
- 2
Documents authentication requirement (JWT Bearer token in Authorization header)
- 3
Generates request body schema with field names, types, and required flags
- 4
Lists response status codes (201, 400, 401) with body schemas and error formats
- 5
Produces code examples in curl, JavaScript fetch, and Python requests
OpenAPI-compatible markdown block with a parameters table, JSON request/response examples, and multi-language code snippets
Cài đặt
clawhub install ryudi84/sovereign-api-docs-generatorChạy lệnh CLI, hoặc dán prompt vào Claude Code, Cursor, Codex hay coding agent bạn đang dùng.