api-docs

What problem does it solve?

This Skill addresses the critical need for clear, accurate, and up-to-date API documentation, preventing integration issues, bugs, and developer frustration.

Core Features & Use Cases

• Endpoint Documentation: Details HTTP methods, routes, parameters, and request/response bodies.
• Code Generation: Can output documentation in Markdown or OpenAPI (Swagger) formats.
• Use Case: Documenting a new REST API for a microservice, ensuring frontend developers and external partners can easily understand and integrate with it.

Quick Start

Use the api-docs skill to document the GET /users/{id} endpoint with its parameters and example response.