New: 97,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

Adding API Docs

by spencerpauly in spencerpauly/awesome-cursor-skills

Generate OpenAPI/Swagger documentation for an API, including endpoint schemas, request/response types, and interactive docs UI.

CC0-1.0Auto-check passedBackend & APIs

Install Adding API Docs

skills CLI
$ npx skills add spencerpauly/awesome-cursor-skills --skill adding-api-docs -a claude-code

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

GitHub CLI
$ gh skill install spencerpauly/awesome-cursor-skills adding-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/spencerpauly/awesome-cursor-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/resources/adding-api-docs .claude/skills/adding-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
adding-api-docs
GitHub stars
841
Token cost
~517 tokens
SKILL.md length
214 words
Files
1
Skills in repo
59
Repo updated
First seen
Licence
CC0-1.0

At a glance

Generate OpenAPI/Swagger documentation for an API, including endpoint schemas, request/response types, and interactive docs UI.

  • Works in 7 steps: Detect the API framework — check for… → For Node.js/Express — install… → For Next.js API routes — create an… → …
  • Tasks that involve OpenAPI specifications
  • SKILL.md covers Steps and Notes
  • Calls npm

What it does

Adding API Docs is an agent skill from spencerpauly/awesome-cursor-skills. Generate OpenAPI/Swagger documentation for an API, including endpoint schemas, request/response types, and interactive docs UI.

Its SKILL.md is about 520 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Backend & APIs, covering OpenAPI specifications and Technical documentation. It works with OpenAPI and Zod. The repository describes itself as: A curated list of awesome skills for Cursor. The licence is CC0-1.0.

When your agent uses it

  • Tasks that involve OpenAPI specifications
  • Tasks that involve Technical documentation

Example prompts

  • “/adding-api-docs”

Requirements

  • Node.js

Workflow steps

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

  1. Detect the API framework — check for Express, Fastify, Next.js API routes, Hono, Django REST Framework, FastAPI, etc.
  2. For Node.js/Express — install swagger-jsdoc and swagger-ui-express
  3. For Next.js API routes — create an openapi.json file manually or use next-swagger-doc to generate from route handlers. Serve the spec at…
  4. For FastAPI (Python) — docs are built-in at /docs (Swagger UI) and /redoc. Ensure Pydantic models are used for request/response types so…
  5. Add interactive docs UI — serve Swagger UI at a /docs route, or use Scalar/Redoc for a modern alternative
  6. Define schemas — create Zod schemas (or JSON Schema) for request bodies and responses, then reference them in the OpenAPI spec. For…
  7. Add authentication documentation — document the auth scheme (Bearer token, API key, OAuth2) in the OpenAPI securitySchemes section.

What it can do on your machine

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

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • npm

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

  • Network

    No URLs in SKILL.md. Its commands use npm, which can reach the network depending on how they are called.

    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.

Context cost

Adding API Docs loads about 517 tokens when it runs. Until then it costs about 36 tokens; SKILL.md has 214 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~36
When it runs · the whole SKILL.md, loaded when a task matches
~517

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 spencerpauly/awesome-cursor-skills at commit 99cd265, republished under its CC0-1.0 licence (© spencerpauly). 214 words, ~517 tokens.

Download SKILL.mdSave it as .claude/skills/adding-api-docs/SKILL.md (or your agent's skills folder).
name
adding-api-docs
description
Generate OpenAPI/Swagger documentation for an API, including endpoint schemas, request/response types, and interactive docs UI.

Add API Documentation (OpenAPI)

Use this skill when the user asks to add API docs, Swagger, OpenAPI spec, or generate endpoint documentation.

Steps

  1. Detect the API framework — check for Express, Fastify, Next.js API routes, Hono, Django REST Framework, FastAPI, etc.

  2. For Node.js/Express — install swagger-jsdoc and swagger-ui-express:

    bash
    npm install swagger-jsdoc swagger-ui-express
npm install -D @types/swagger-jsdoc @types/swagger-ui-express

    Create the OpenAPI spec from JSDoc annotations on route handlers:

    ts
    /**
 * @openapi
 * /api/users:
 *   get:
 *     summary: List all users
 *     responses:
 *       200:
 *         description: A list of users
 */

  3. For Next.js API routes — create an openapi.json file manually or use next-swagger-doc to generate from route handlers. Serve the spec at /api/docs.

  4. For FastAPI (Python) — docs are built-in at /docs (Swagger UI) and /redoc. Ensure Pydantic models are used for request/response types so schemas are auto-generated.

  5. Add interactive docs UI — serve Swagger UI at a /docs route, or use Scalar/Redoc for a modern alternative:

    bash
    npm install @scalar/express-api-reference

  6. Define schemas — create Zod schemas (or JSON Schema) for request bodies and responses, then reference them in the OpenAPI spec. For TypeScript projects, use zod-to-openapi to generate schemas from existing Zod validators.

  7. Add authentication documentation — document the auth scheme (Bearer token, API key, OAuth2) in the OpenAPI securitySchemes section.

Notes

  • Keep the spec in sync with the actual API — generate from code when possible rather than maintaining a separate YAML file.
  • Add example values to schemas for better developer experience.
  • Version the API docs alongside the code.

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

Files

Just SKILL.md in resources/adding-api-docs of spencerpauly/awesome-cursor-skills.

Open the folder on GitHubat commit 99cd265

Compare with similar skills

Adding 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.

Adding API Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Adding API Docs this skillspencerpauly/awesome-cursor-skills841—~517Automated safety check: PassCC0-1.0
REST API Designcuriositech/some_claude_skills2431 repos~3.1kAutomated safety check: PassMIT
OpenAPI to MCP Servermcp-use/mcp-use11k—~5.2kAutomated safety check: PassApache-2.0
CLI Creatorhuangruiteng/CS-Notes4k2 repos~2.7kAutomated safety check: PassApache-2.0
API Documentinghuangjia2019/claude-code-engineering1.1k1 repos~396Automated safety check: PassNone
Api2clialexknowshtml/api2cli455—~2.9kAutomated safety check: PassMIT

Similar skills

  • REST API Design

    curiositech/some_claude_skills

    Design REST API endpoints with Zod validation and OpenAPI documentation.

    243 GitHub starsUsed in 1 repo~3.1k tokens
    Backend & APIsAuto-check passed

  • OpenAPI to MCP Server

    mcp-use/mcp-use

    Turns an OpenAPI or Swagger spec into an MCP server with the mcp-use TypeScript SDK, mapping each operation to a tool, wiring auth, testing and deploying.

    11k GitHub stars~5.2k tokensUpdated yesterday
    Backend & APIsAuto-check passed

  • CLI Creator

    huangruiteng/CS-Notes

    Build a composable CLI for Codex from API docs, an OpenAPI spec, existing curl examples, an SDK, a web app, an admin tool, or a local script.

    4k GitHub starsUsed in 2 repos~2.7k tokens
    Backend & APIsAuto-check passed

  • API Documenting

    huangjia2019/claude-code-engineering

    Generate API documentation from code. An agent skill from huangjia2019/claude-code-engineering.

    1.1k GitHub starsUsed in 1 repo~396 tokens
    Backend & APIsAuto-check passed

  • Api2cli

    alexknowshtml/api2cli

    Generate a working CLI from any API, then wrap it in a Claude Code skill.

    455 GitHub stars~2.9k tokensUpdated 7 mo ago
    Backend & APIsAuto-check passed

  • Distilled SDK

    alchemy-run/distilled

    Build or update a distilled SDK for an API provider — sourcing its OpenAPI/Smithy/GraphQL/discovery description, adding the spec mirror that feeds it, generating packages/<provider, listing it on…

    431 GitHub stars~6k tokensUpdated today
    Backend & APIsAuto-check passed

More from spencerpauly/awesome-cursor-skills

All 59 skills in this repo

  • Generating Images

    spencerpauly/awesome-cursor-skills

    Generate or edit images using the OpenAI Image API (gpt-image-2).

    841 GitHub stars~3.7k tokensUpdated 2 mo ago
    Auto-check: notes

  • Babysitting PR

    spencerpauly/awesome-cursor-skills

    Monitor a pull request for CI failures, review comments, and merge conflicts — then fix them automatically.

    841 GitHub stars~930 tokensUpdated 2 mo ago
    Auto-check passed

  • Best Of N Solving

    spencerpauly/awesome-cursor-skills

    Solve a hard problem by trying multiple approaches in parallel using isolated git worktrees.

    841 GitHub stars~698 tokensUpdated 2 mo ago
    Auto-check passed

  • Grinding Until Pass

    spencerpauly/awesome-cursor-skills

    Keep iterating on code changes until the tests pass, the build succeeds, or linting is clean.

    841 GitHub stars~796 tokensUpdated 2 mo ago
    Auto-check passed

  • Parallel CI Triage

    spencerpauly/awesome-cursor-skills

    When GitHub Actions fails, fetch failing job logs and assign each failing job to a separate subagent that fixes its slice of the problem in parallel.

    841 GitHub stars~793 tokensUpdated 2 mo ago
    Auto-check passed

  • Parallel Exploring

    spencerpauly/awesome-cursor-skills

    Explore a large codebase in parallel by launching multiple explore subagents that each investigate a different area simultaneously.

    841 GitHub stars~787 tokensUpdated 2 mo ago
    Auto-check: notes

Works with

Categories

Questions about Adding API Docs

What does Adding API Docs do?

Generate OpenAPI/Swagger documentation for an API, including endpoint schemas, request/response types, and interactive docs UI. Adding API Docs is an agent skill from spencerpauly/awesome-cursor-skills. Generate OpenAPI/Swagger documentation for an API, including endpoint schemas, request/response types, and interactive docs UI.

When should I use Adding API Docs?

Adding API Docs fits situations like: tasks that involve OpenAPI specifications; tasks that involve Technical documentation.

How do I install Adding API Docs in Claude Code?

Run `npx skills add spencerpauly/awesome-cursor-skills --skill adding-api-docs -a claude-code`. Or copy the skill folder (resources/adding-api-docs in spencerpauly/awesome-cursor-skills) into .claude/skills/adding-api-docs in your project. Claude Code loads it when a task matches its description.

How do I install Adding API Docs in Codex?

Run `npx skills add spencerpauly/awesome-cursor-skills --skill adding-api-docs -a codex`. Or copy the skill folder (resources/adding-api-docs in spencerpauly/awesome-cursor-skills) into .agents/skills/adding-api-docs in your project. Codex loads it when a task matches its description.

Can I use Adding 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 spencerpauly/awesome-cursor-skills --skill adding-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/adding-api-docs, .gemini/skills/adding-api-docs, .github/skills/adding-api-docs and .opencode/skills/adding-api-docs in your project.

What does Adding API Docs need to run?

Going by SKILL.md and its folder, Adding API Docs needs the command-line tools its instructions call (npm). Our summary lists: Node.js.

Does Adding API Docs access the network?

SKILL.md contains no URLs. Its commands use npm, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Adding 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 Adding API Docs use?

Adding API Docs is published under the CC0-1.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Adding API Docs use?

About 517 tokens (SKILL.md is roughly 2.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Adding API Docs?

Skills that share tags, products or a category with Adding API Docs: REST API Design (curiositech/some_claude_skills, 243 stars), OpenAPI to MCP Server (mcp-use/mcp-use, 11k stars), CLI Creator (huangruiteng/CS-Notes, 4k stars) and API Documenting (huangjia2019/claude-code-engineering, 1.1k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Adding API Docs?

spencerpauly (a GitHub user) maintains it in spencerpauly/awesome-cursor-skills, which has 841 GitHub stars. The repository holds 59 skills in this directory. The repository was last updated on August 2, 2026.

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