api-documentor

The API Documentor skill is designed to automatically generate comprehensive API documentation and client SDKs directly from source code, eliminating the need for time-consuming manual documentation. By analyzing REST API code or GraphQL resolvers, it produces accurate OpenAPI/Swagger specifications, GraphQL schema documentation, and language-specific SDKs. This ensures that API documentation remains synchronized with the implementation, reducing errors and improving developer efficiency. The skill streamlines the workflow for API teams, saving significant token usage and accelerating the onboarding process for API consumers.

Key features include automatic detection of endpoints, extraction of request and response schemas, generation of human-readable API reference documentation, and creation of interactive API explorers. It supports multiple client SDK languages, including Python, JavaScript/TypeScript, Go, Java, and Ruby, and can validate API implementations against their specifications. Additional functionality includes generating mock servers with example or schema-based responses, simulating delays and errors, and documenting GraphQL types, queries, mutations, subscriptions, and directives.

The API Documentor skill is ideal for developers, API teams, and organizations building REST or GraphQL services who need consistent, up-to-date documentation. It is particularly useful when creating new APIs, updating existing services, generating client SDKs, publishing API reference materials, validating API compliance, or onboarding new developers. By providing automated documentation and validation tools, it supports smoother API versioning, testing, and deployment, while enhancing the overall developer experience and reducing maintenance overhead.