Api Reference Documentation

What it does

This skill assists with creating comprehensive API documentation for developer integration, following the OpenAPI 3.0 specification. It helps generate documentation that includes endpoint descriptions, parameter details (like limit and category), request/response examples, authentication methods, and error responses. The goal is to produce clear and usable documentation for developers integrating with an API.

When to use it

• When you need to create documentation for a new or existing API.
• To ensure consistent formatting and structure in your API reference materials.
• For generating developer-friendly guides that explain how to interact with your API, including authentication and error handling.
• When migrating an existing API and needing to document breaking changes.

Key capabilities

• Supports OpenAPI 3.0 specification (version 3.0.3).
• Generates documentation for endpoints, parameters, and responses.
• Includes descriptions of authentication methods (bearerAuth using JWT).
• Provides guidance on best practices like including request/response examples and maintaining version documentation.
• Suggests tools such as Swagger Editor/UI, Redoc, Postman Documentation, and Stoplight.

Example prompts

• "Generate API documentation for the /products endpoint."
• "Document the authentication process using bearer tokens (JWT)."
• "Create a migration guide for changes to version 1.0.0 of the E-Commerce API."

Tips & gotchas

• The skill is designed around the OpenAPI 3.0 specification, so familiarity with this standard will be helpful.
• Ensure you have clear endpoint definitions and schemas available as input for the documentation generation process.