api-doc-template

What problem does it solve?

Teams often struggle with inconsistent API documentation across RESTful and gRPC interfaces, leading to miscommunication and integration issues. This skill provides a standardized template to ensure all API docs follow a clear, repeatable structure.

Core Features & Use Cases

• Standard template with sections for endpoint summaries, request/response formats, parameter definitions, error codes, and example payloads.
• Supports RESTful and gRPC interfaces; adaptable to additional interface types.
• Use Case: Document a new service endpoint quickly by filling in endpoint details and data contracts, ensuring consistent terminology and structure across teams.

Quick Start

Use the api-doc-template skill to generate a new API documentation draft by applying the standard template to your endpoint and filling in URL, method, parameters, and responses.