Add Api Documentation Automatically

The problem

Stale or missing API documentation forces developers to dig through source code and middleware to understand how an endpoint actually behaves. Manual updates to OpenAPI specs are error-prone and frequently drift from the underlying implementation.

What it does

• Analyzes project routes, controllers, and schemas to generate accurate OpenAPI/Swagger specifications.
• Identifies and repairs discrepancies between existing documentation and actual code behavior.
• Maps request/response schemas, including required fields, enums, and authentication requirements.
• Sets up local documentation interfaces like Swagger UI within the existing project structure.
• Validates generated specifications against framework-specific routing and types.

Frameworks & tools

Works with RESTful backends, OpenAPI 3.x, Swagger, and standard web frameworks across Node.js, Python, and Go. Uses bash for spec validation and Read/Edit for source code analysis.

Why this beats prompting it yourself

Generic prompts often hallucinate endpoints or miss hidden middleware logic. This skill follows a strict source priority sequence—inspecting active route definitions and handlers first—to ensure the documentation reflects executable reality, not just optimistic guesses.

Use cases

• Generating a full OpenAPI spec for a legacy service with zero documentation.
• Syncing Swagger docs after a major refactor of request/response models.
• Auditing public vs. internal endpoints to ensure sensitive routes aren't exposed.
• Standardizing error codes and authentication headers across a microservice.

Known limitations

Will not document endpoints that lack code evidence or clear route definitions. Does not perform destructive commands or modify functional endpoint logic.