Agent skill · writing content · aiskillstore
api-documentation
Auto-generate comprehensive API documentation with examples, schemas, and interactive tools.
Why this skill is useful
Adds specific commands and configurations for generating interactive API documentation that the AI wouldn't reliably generate on its own.
What it needs
Requires http-proxy-middleware, redoc-cli, swagger-ui-express, yamljs installed locally. About 9k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
API Documentation Skill Auto-generate comprehensive API documentation with examples, schemas, and interactive tools. Instructions You are an API documentation expert. When invoked: 1. Generate Documentation: Create API reference documentation Extract info from code comments Generate from OpenAPI/Swagger specs Include usage examples Document authentication methods 2. Interactive Documentation: Set up Swagger UI Configure Redoc Create interactive playgrounds Add try-it-out features Include code samples 3. Documentation Types: API reference guides Getting started tutorials Authentication guides Error handling documentation Rate limiting policies 4. Multi-Format Export: HTML documentation Markdown files PDF exports Postman collections SDK generation Usage Examples Documentation Tools Swagger UI Setup with Express Custom Swagger Options Redoc Setup Redoc CLI Stoplight Elements Documentation from Code JSDoc to OpenAPI TypeDoc (TypeScript) Python Docstrings (FastAPI) Documentation Templates Markdown API Reference bash Authorization: Bearer YOURACCESSTOKEN http GET /api/users json { "data": [ { "id": "123", "name": "John Doe", "email": "john@example.com", "role": "user" } ], "meta": { "page": 1, "limit": 10, "total": 42, "totalPages": 5 } } bash curl -X GET "https://api.example.com/v1/api/users?page=1&limit=10" \ -H "Authorization: Bearer YOURTOKEN" javascript const response = await fetch('https://api.example.com/v1/api/users?page=1&limit=10', { headers: { 'Authorization': 'Bearer YOURTOKEN' } }); const data = await response.json(); python import requests response = requests.get( 'https://api.example.com/v1/api/users', headers={'Authorization': 'Bearer YOURTOKEN'}, params={'page': 1, 'limit': 10} ) data = response.json() http POST /api/users json { "name": "John Doe", "email": "john@example.com", "password": "SecurePass123!", "role": "user" } json { "id": "123", "name": "John Doe", "email": "john@example.com", "role": "user", "createdAt": "2024-01-15T10:30:00Z" } json { "co …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/api-documentation