Agent skill · writing content · jeremylongshore
generating-api-docs
Create comprehensive API documentation with examples, authentication
Why this skill is useful
Adds detailed domain-specific knowledge for generating interactive API documentation that the AI wouldn't reliably generate on its own.
What it needs
Requires docusaurus, redoc, stoplight-elements, swagger-ui installed locally. About 3k tokens when loaded. Last updated 2026-08-07. 2,604 stars on the source repository.
What this skill does
Generating API Documentation Overview Create comprehensive, interactive API documentation from OpenAPI specifications with runnable code examples, authentication guides, error reference tables, and SDK quick-start tutorials. Generate documentation sites using Redoc, Stoplight Elements, or Swagger UI with custom branding, versioned navigation, and full-text search. Prerequisites OpenAPI 3.0+ specification with descriptions, examples, and complete schema definitions Documentation generator: Redoc, Stoplight Elements, Swagger UI, or Docusaurus with OpenAPI plugin Code example generator for multiple languages (curl, JavaScript, Python, Go) Static site hosting for documentation deployment (GitHub Pages, Netlify, Vercel) Custom branding assets (logo, color scheme) for white-labeled documentation Instructions 1. Read the OpenAPI specification using Read and audit documentation completeness: verify all operations have summary, description, parameter descriptions, and at least one example per request/response. 2. Enrich the specification with long-form descriptions using Markdown: add getting-started guides, authentication flow explanations, and rate limiting documentation in the info.description or x-documentation extensions. 3. Generate interactive documentation using Redoc or Stoplight Elements with "Try It" functionality that allows consumers to execute requests directly from the documentation page. 4. Create runnable code examples for every endpoint in curl, JavaScript (fetch/axios), Python (requests/httpx), and Go (net/http), with proper authentication header injection. 5. Build an authentication guide covering all supported auth schemes: API key setup, OAuth2 authorization code flow walkthrough, JWT token lifecycle, and credential rotation procedures. 6. Add an error reference section that documents every error code, its meaning, common causes, and resolution steps -- organized by HTTP status code with searchable error code index. 7. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills jeremylongshore/generating-api-docs--635364