api-documenter

What it does

This skill enables AI agents to automatically generate comprehensive documentation for APIs. It transforms raw code or endpoint definitions into readable guides that explain functionality, parameters, and usage examples.

When to use it

• You need to onboard new developers to a complex backend service quickly.
• An API has changed frequently, and you want to keep user-facing docs in sync with the latest version.
• You are building an internal tool and require immediate documentation for your team's reference.
• You want to create standard OpenAPI or Swagger specifications from existing codebases without manual effort.

Key capabilities

• Generates human-readable API documentation from source code or endpoint definitions.
• Extracts and explains function parameters, return types, and error codes.
• Produces usage examples to help developers integrate services correctly.
• Supports various output formats suitable for developer portals or internal wikis.

Example prompts

• "Generate full API documentation for this REST service based on the provided code snippets."
• "Create a user guide explaining how to authenticate and make requests using these endpoints."
• "Document this GraphQL schema, including field descriptions and query examples."

Tips & gotchas

Ensure your input code is well-commented or includes clear metadata, as the quality of generated docs depends heavily on available context. Review outputs carefully to verify accuracy, especially for complex authentication flows or edge cases not explicitly marked in the source.