Agent skill · writing content · aiskillstore
api-documentation
Create comprehensive API documentation for developers. Use when documenting REST APIs, GraphQL schemas, or SDK methods. Handles OpenAPI/Swagger, interactive docs, examples, and API reference guides.
Why this skill is useful
Provides detailed OpenAPI specifications and documentation generation techniques that the AI wouldn't reliably generate on its own.
What it needs
About 4k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
API Documentation When to use this skill API Development: When adding new endpoints External Release: Public API launch Team Collaboration: Frontend-backend interface definition Instructions Step 1: OpenAPI (Swagger) Spec Step 2: Generate Documentation from Code (JSDoc/Decorators) Express + TypeScript: Step 3: Interactive Documentation Swagger UI Setup: Step 4: Examples & Guides Output format API Documentation Structure Constraints Required Rules (MUST) 1. Real Examples: Provide working code examples 2. Error Cases: Document not only success but also failure cases 3. Keep Updated: Update documentation when API changes Prohibited (MUST NOT) 1. Real Keys in Examples: Do not use real API keys/passwords in examples 2. Vague Descriptions: Unclear descriptions like "returns data" Best practices 1. Try It Out: Provide interactive documentation (Swagger UI) 2. Provide SDK: SDK and examples for major languages 3. Changelog: Document API changes References OpenAPI Specification Swagger UI Redoc Metadata Version Current Version: 1.0.0 Last Updated: 2025-01-01 Compatible Platforms: Claude, ChatGPT, Gemini Tags #API-documentation #OpenAPI #Swagger #REST #developer-docs #documentation Examples Example 1: Basic usage <!-- Add example content here --> Example 2: Advanced usage <!-- Add advanced example content here -->
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/api-documentation--294358