Api Documenter

The API Documenter skill transforms raw code snippets, OpenAPI specifications, or database schemas into comprehensive, human-readable documentation. It automatically generates structured guides including endpoint descriptions, request/response formats, and usage examples to streamline developer onboarding.

When to use it

• You have a new REST API built with FastAPI, Express, or Django and need immediate technical documentation without writing it manually.
• Your team is integrating a third-party service via JSON-RPC or GraphQL and requires clear parameter definitions and error codes.
• You are maintaining legacy codebases where original comments are missing or outdated, needing to reverse-engineer functionality from the source.

Key capabilities

• Parses various input formats including OpenAPI/Swagger YAML/JSON files and raw Python/JavaScript function definitions.
• Generates structured markdown output containing endpoint summaries, method details (GET, POST, PUT), and data models.
• Extracts and documents authentication requirements, rate limits, and specific error handling scenarios from the code logic.

Example prompts

• "Analyze this OpenAPI YAML file and generate a Markdown guide explaining how to create a new user account."
• "Review these Python FastAPI route definitions and document the input validation rules for the payment processing endpoint."
• "Convert this database schema definition into a reference document detailing the relationships between the orders and customers tables."

Tips & gotchas

Ensure your source code includes clear docstrings or standard metadata tags, as the tool relies on these to populate accurate descriptions. Complex nested logic may require manual review of the generated output to verify edge cases are correctly interpreted.