authoring-api-docs

What problem does it solve?

This Skill automates the creation of comprehensive and accurate API reference documentation, ensuring developers have the information they need to integrate with your APIs.

Core Features & Use Cases

• REST Endpoint Documentation: Generates detailed documentation for individual REST API endpoints, including parameters, request/response examples, and error codes.
• SDK/Library Function Documentation: Creates documentation for functions within SDKs or libraries, covering parameters, return values, and error handling.
• OpenAPI Spec Integration: Parses OpenAPI/Swagger specifications to automatically generate structured API reference documentation.
• Use Case: A developer needs to document a new set of REST endpoints. They can use this skill to quickly generate well-formatted Markdown files for each endpoint based on the API's OpenAPI specification.

Quick Start

Use the authoring-api-docs skill to generate documentation for the '/users/{id}' GET endpoint.