api-docs-generator

What it does

This skill enables AI agents to automatically generate, update, and maintain API documentation based on codebases or schema definitions. It streamlines developer workflows by ensuring technical documentation stays synchronized with actual implementation details without manual intervention.

When to use it

• You need to document a new REST or GraphQL API quickly after development is complete.
• Your team requires up-to-date OpenAPI (Swagger) specifications for frontend integration.
• You want to automate the maintenance of README files when API endpoints change frequently.
• Developers need clear usage examples and parameter descriptions generated directly from code comments.

Key capabilities

• Generates comprehensive API documentation from source code or schema inputs.
• Creates structured content including endpoint lists, request/response formats, and authentication details.
• Supports multiple output formats suitable for developer portals or internal wikis.
• Reduces manual effort in keeping documentation aligned with code changes.

Example prompts

• "Generate OpenAPI 3.0 documentation for my Express.js backend based on the provided route definitions."
• "Create a Markdown README documenting the authentication flow and user endpoints for this API."
• "Extract all GET and POST methods from this Python FastAPI codebase and format them as technical docs."

Tips & gotchas

Ensure your code includes clear comments or uses standard schema annotations (like Pydantic models) to maximize generation accuracy. The skill works best when the input code is well-structured and follows consistent naming conventions for endpoints and parameters.