New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Generating API Docs

by jeremylongshore in jeremylongshore/tons-of-skills-marketplace

Create comprehensive API documentation with examples, authentication guides, and SDKs.

MITAuto-check passedDevelopment

Install Generating API Docs

skills CLI
$ npx skills add jeremylongshore/tons-of-skills-marketplace --skill generating-api-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install jeremylongshore/tons-of-skills-marketplace generating-api-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/jeremylongshore/tons-of-skills-marketplace.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/.curated/generating-api-docs .claude/skills/generating-api-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
generating-api-docs
GitHub stars
2.8k
Token cost
~1.4k tokens
SKILL.md length
575 words
Files
4 (incl. references)
Skills in repo
3,342
Repo updated
First seen
Licence
MIT

At a glance

Create comprehensive API documentation with examples, authentication guides, and SDKs.

  • Works in 8 steps: Read the OpenAPI specification using… → Enrich the specification with long-form… → Generate interactive documentation using… → …
  • Creating comprehensive API documentation
  • SKILL.md covers Overview, Prerequisites, Instructions and Output, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Generating API Docs is an agent skill from jeremylongshore/tons-of-skills-marketplace. Create comprehensive API documentation with examples, authentication guides, and SDKs. Use when creating comprehensive API documentation. Trigger with phrases like "generate API docs", "create API documentation", or "document the API".

Its SKILL.md is about 1.4k tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files, including reference files (for example `references/errors.md`, `references/examples.md` and `references/implementation.md`). Compatibility notes: Designed for Claude Code

It sits in Development, covering Technical documentation. It works with OpenAPI. The repository describes itself as: Model-agnostic agent-skills platform with a harness-free canonical layer, verified adapters, and the ccpi package manager. Explore at tonsofskills.com. The licence is MIT.

When your agent uses it

  • Creating comprehensive API documentation
  • With phrases like generate API docs
  • Create API documentation
  • Document the API

Example prompts

  • “generate API docs”
  • “create API documentation”
  • “document the API”
  • “/generating-api-docs”

Requirements

  • Python 3
  • Compatibility (from SKILL.md): Designed for Claude Code
  • Pre-approved tools (allowed-tools): Read, Write, Edit, Grep, Glob, Bash(api:docs-*)

Workflow steps

8 steps, taken from the first numbered list in SKILL.md.

  1. Read the OpenAPI specification using Read and audit documentation completeness: verify all operations have summary, description, parameter…
  2. Enrich the specification with long-form descriptions using Markdown: add getting-started guides, authentication flow explanations, and…
  3. Generate interactive documentation using Redoc or Stoplight Elements with "Try It" functionality that allows consumers to execute requests…
  4. Create runnable code examples for every endpoint in curl, JavaScript (fetch/axios), Python (requests/httpx), and Go (net/http), with…
  5. Build an authentication guide covering all supported auth schemes: API key setup, OAuth2 authorization code flow walkthrough, JWT token…
  6. Add an error reference section that documents every error code, its meaning, common causes, and resolution steps -- organized by HTTP…
  7. Configure documentation versioning so consumers can switch between API versions (v1, v2) with visual diff highlighting showing changes…
  8. Set up automated documentation deployment: on OpenAPI spec changes, regenerate the documentation site and deploy to hosting with cache…

What it can do on your machine

Read from SKILL.md and the folder at commit 23ea8d4. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Write
    • Edit
    • Grep
    • Glob
    • Bash(api:docs-*)

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • redocly.com
    • stoplight.io
    • swagger.io

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    Designed for Claude Code

    From compatibility in the SKILL.md frontmatter.

Context cost

Generating API Docs loads about 1.4k tokens when it runs, and up to ~3.1k if it reads all its reference files. Until then it costs about 64 tokens; SKILL.md has 575 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~64
When it runs · the whole SKILL.md, loaded when a task matches
~1.4k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~3.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from jeremylongshore/tons-of-skills-marketplace at commit 23ea8d4, republished under its MIT licence (© jeremylongshore). 575 words, ~1,387 tokens.

Download SKILL.mdSave it as .claude/skills/generating-api-docs/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
generating-api-docs
description
Create comprehensive API documentation with examples, authentication guides, and SDKs. Use when creating comprehensive API documentation. Trigger with phrases like "generate API docs", "create API documentation", or "document the API".
allowed-tools
Read, Write, Edit, Grep, Glob, Bash(api:docs-*)
compatibility
Designed for Claude Code
version
1.27.0
author
Jeremy Longshore <jeremy@intentsolutions.io>
license
MIT
tags
api, authentication, api-docs

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. Configure documentation versioning so consumers can switch between API versions (v1, v2) with visual diff highlighting showing changes between versions.
  8. Set up automated documentation deployment: on OpenAPI spec changes, regenerate the documentation site and deploy to hosting with cache invalidation.

See ${CLAUDE_SKILL_DIR}/references/implementation.md for the full implementation guide.

Output

  • ${CLAUDE_SKILL_DIR}/docs/site/ - Generated documentation website (HTML/CSS/JS)
  • ${CLAUDE_SKILL_DIR}/docs/guides/authentication.md - Authentication flow guide with code examples
  • ${CLAUDE_SKILL_DIR}/docs/guides/getting-started.md - Quick-start tutorial for first API call
  • ${CLAUDE_SKILL_DIR}/docs/reference/errors.md - Complete error code reference with resolution steps
  • ${CLAUDE_SKILL_DIR}/docs/examples/ - Per-endpoint code examples in multiple languages
  • ${CLAUDE_SKILL_DIR}/docs/config/redoc.yaml - Documentation generator configuration with branding
Show full SKILL.md (239 more words)Show less

Error Handling

ErrorCauseSolution
Missing examplesOpenAPI spec lacks example or examples for request/response schemasGenerate examples from schema using Faker-based data; flag missing examples in spec linting
Stale documentationDocs deployed from an older spec version than the running APITie doc deployment to API deployment pipeline; version docs alongside API releases
Broken Try-It requestsCORS not configured for documentation domain on the API serverAdd documentation domain to CORS Access-Control-Allow-Origin; or use a proxy for Try-It requests
Code example errorsGenerated code example uses deprecated SDK method or wrong import pathAuto-test code examples against a staging API; version examples alongside SDK releases
Search not workingFull-text search index not rebuilt after content updateInclude search index regeneration in documentation build pipeline; verify Algolia/Lunr config

Refer to ${CLAUDE_SKILL_DIR}/references/errors.md for comprehensive error patterns.

Examples

Stripe-style API docs: Generate a three-column documentation layout with navigation on the left, description in the center, and code examples on the right, with language switcher for curl/Node/Python/Ruby.

Versioned documentation site: Host v1 and v2 documentation side-by-side with a version switcher dropdown, and a changelog page highlighting breaking changes and migration steps between versions.

Developer portal: Combine API reference docs with getting-started tutorials, use-case guides, webhooks documentation, and SDK installation instructions in a single searchable portal.

See ${CLAUDE_SKILL_DIR}/references/examples.md for additional examples.

Resources

© jeremylongshore, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 3 other files (references) in skills/.curated/generating-api-docs of jeremylongshore/tons-of-skills-marketplace.

  • SKILL.md
  • references/errors.md
  • references/examples.md
  • references/implementation.md

Open the folder on GitHubat commit 23ea8d4

Compare with similar skills

Generating API Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Generating API Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Generating API Docs this skilljeremylongshore/tons-of-skills-marketplace2.8k—~1.4kAutomated safety check: PassMIT
Nacos API Doc Updatenacos-group/nacos-group.github.io115—~3.3kAutomated safety check: PassApache-2.0
API Documentation Generatorluongnv89/claude-howto42k—~429Automated safety check: PassMIT
Dashclaw Shipucsandman/DashClaw310—~7.2kAutomated safety check: PassMIT
Agentic Workflows API Documentation Lungoagntcy/coffeeAgntcy112—~2.6kAutomated safety check: PassApache-2.0
API Documentation Generatordavila7/claude-code-templates32k8 repos~2.8kAutomated safety check: PassMIT

Similar skills

  • Nacos API Doc Update

    nacos-group/nacos-group.github.io

    Updates Nacos API documentation from Swagger api.json. An agent skill from nacos-group/nacos-group.github.io.

    115 GitHub stars~3.3k tokensUpdated 14 days ago
    DevelopmentAuto-check passed

  • API Documentation Generator

    luongnv89/claude-howto

    Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users…

    42k GitHub stars~429 tokensUpdated 7 days ago
    DevelopmentAuto-check passed

  • Dashclaw Ship

    ucsandman/DashClaw

    The single command that gets a DashClaw change ON MAIN AND LIVE — it resolves everything blocking production, never defers, and never hands back a checklist.

    310 GitHub stars~7.2k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Agentic Workflows API Documentation Lungo

    agntcy/coffeeAgntcy

    Authors and maintains the human-facing Agentic Workflows API documentation for the lungo subproject at coffeeAGNTCY/coffeeagents/lungo/docs/workflow-instanceapi.md.

    112 GitHub stars~2.6k tokensUpdated today
    DevelopmentAuto-check passed

  • API Documentation Generator

    davila7/claude-code-templates

    Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices

    32k GitHub starsUsed in 8 repos~2.8k tokens
    DevelopmentAuto-check passed

  • Code Documenter

    Jeffallan/claude-skills

    Generates and validates docstrings, OpenAPI specs, JSDoc annotations and user guides, running every code example through a real compiler or linter before reporting coverage.

    12k GitHub stars~1.5k tokensUpdated 4 days ago
    DevelopmentAuto-check passed

More from jeremylongshore/tons-of-skills-marketplace

All 3,342 skills in this repo

  • Performing Security Code Review

    jeremylongshore/tons-of-skills-marketplace

    Execute this skill enables AI assistant to conduct a security-focused code review using the security-agent plugin.

    2.8k GitHub starsUsed in 2 repos~1.3k tokens
    Auto-check: notes

  • Analyzing Text With NLP

    jeremylongshore/tons-of-skills-marketplace

    Execute this skill enables AI assistant to perform natural language processing and text analysis using the nlp-text-analyzer plugin.

    2.8k GitHub starsUsed in 1 repo~819 tokens
    Auto-check passed

  • Building Neural Networks

    jeremylongshore/tons-of-skills-marketplace

    Execute this skill allows AI assistant to construct and configure neural network architectures using the neural-network-builder plugin.

    2.8k GitHub starsUsed in 1 repo~1k tokens
    Auto-check passed

  • Detecting Data Anomalies

    jeremylongshore/tons-of-skills-marketplace

    Process identify anomalies and outliers in datasets using machine learning algorithms.

    2.8k GitHub starsUsed in 1 repo~1.4k tokens
    Auto-check passed

  • Explaining Machine Learning Models

    jeremylongshore/tons-of-skills-marketplace

    Build this skill enables AI assistant to provide interpretability and explainability for machine learning models.

    2.8k GitHub starsUsed in 1 repo~1k tokens
    Auto-check passed

  • Optimizing Prompts

    jeremylongshore/tons-of-skills-marketplace

    Execute this skill optimizes prompts for large language models (llms) to reduce token usage, lower costs, and improve performance.

    2.8k GitHub starsUsed in 1 repo~1k tokens
    Auto-check passed

Works with

Categories

Questions about Generating API Docs

What does Generating API Docs do?

Create comprehensive API documentation with examples, authentication guides, and SDKs. Generating API Docs is an agent skill from jeremylongshore/tons-of-skills-marketplace. Create comprehensive API documentation with examples, authentication guides, and SDKs.

When should I use Generating API Docs?

Generating API Docs fits situations like: creating comprehensive API documentation; with phrases like generate API docs; create API documentation; document the API.

How do I install Generating API Docs in Claude Code?

Run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill generating-api-docs -a claude-code`. Or copy the skill folder (skills/.curated/generating-api-docs in jeremylongshore/tons-of-skills-marketplace) into .claude/skills/generating-api-docs in your project. Claude Code loads it when a task matches its description.

How do I install Generating API Docs in Codex?

Run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill generating-api-docs -a codex`. Or copy the skill folder (skills/.curated/generating-api-docs in jeremylongshore/tons-of-skills-marketplace) into .agents/skills/generating-api-docs in your project. Codex loads it when a task matches its description.

Can I use Generating API Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill generating-api-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/generating-api-docs, .gemini/skills/generating-api-docs, .github/skills/generating-api-docs and .opencode/skills/generating-api-docs in your project.

What does Generating API Docs need to run?

SKILL.md names no scripts, command-line tools or credentials: Generating API Docs is instructions for the agent only. Our summary lists: Python 3. Its frontmatter pre-approves these tools: Read, Write, Edit, Grep, Glob, Bash(api:docs-*). Compatibility (from SKILL.md): Designed for Claude Code.

Does Generating API Docs access the network?

SKILL.md names 3 domains. As links in the text: redocly.com, stoplight.io and swagger.io. This is read from the text; nothing was executed.

Is Generating API Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Generating API Docs use?

Generating API Docs is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Generating API Docs use?

About 1.4k tokens (SKILL.md is roughly 5.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1.8k tokens, read only when the agent opens those files.

What are the alternatives to Generating API Docs?

Skills that share tags, products or a category with Generating API Docs: Nacos API Doc Update (nacos-group/nacos-group.github.io, 115 stars), API Documentation Generator (luongnv89/claude-howto, 42k stars), Dashclaw Ship (ucsandman/DashClaw, 310 stars) and Agentic Workflows API Documentation Lungo (agntcy/coffeeAgntcy, 112 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Generating API Docs?

jeremylongshore (a GitHub user) maintains it in jeremylongshore/tons-of-skills-marketplace, which has 2,821 GitHub stars. The repository holds 3,342 skills in this directory. The repository was last updated on October 8, 2026.

Source: jeremylongshore/tons-of-skills-marketplace on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.