api-documentation

To generate OpenAPI specifications, inventory your API endpoints, schemas, and authentication rules. This Skill transforms those raw API behaviors into structured OpenAPI or Swagger specs complete with paths, security definitions, and example responses.

The best way to create a developer guide is to document usage patterns alongside endpoint definitions. This Skill writes developer guides, code samples, and troubleshooting notes by mapping request and response shapes to practical integration scenarios.

Yes, you can document API authentication rules and error codes. The workflow inventories security schemes, rate limits, and error handling behaviors, ensuring your documentation accurately reflects access control and failure states.

To structure interactive docs for a new API launch, define your endpoints and schemas first. This Skill plans the documentation site by synchronizing the OpenAPI specs with getting-started guides and example requests.

Yes, this approach keeps API specs and developer guides synchronized. It requires documentation workflows that inventory API behavior and define security, ensuring the generated OpenAPI specifications and developer materials remain aligned.

To start writing API documentation, you need the raw details of your service functionality. Providing endpoint behaviors, request and response shapes, and authentication patterns allows the workflow to inventory and generate comprehensive specs.