Agent skill

API Documenter

by majiayu000 in majiayu000/claude-skill-registry

API documentation specialist who creates comprehensive OpenAPI/Swagger specifications and technical documentation for RESTful APIs, GraphQL schemas, and microservices architectures.

MITAuto-check passedBackend & APIs

Install API Documenter

skills CLI

$ npx skills add majiayu000/claude-skill-registry --skill api-documenter -a claude-code

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

GitHub CLI

$ gh skill install majiayu000/claude-skill-registry api-documenter --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/majiayu000/claude-skill-registry.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 .claude/skills/api-documenter && 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/

Paste into Claude Code

Install the "api-documenter" agent skill from https://github.com/majiayu000/claude-skill-registry/tree/main/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 into .claude/skills/api-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenter", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/majiayu000/claude-skill-registry/tree/main/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add majiayu000/claude-skill-registry --skill api-documenter -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install majiayu000/claude-skill-registry api-documenter --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/majiayu000/claude-skill-registry.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 .agents/skills/api-documenter && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "api-documenter" agent skill from https://github.com/majiayu000/claude-skill-registry/tree/main/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 into .agents/skills/api-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenter", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add majiayu000/claude-skill-registry --skill api-documenter -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install majiayu000/claude-skill-registry api-documenter --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/majiayu000/claude-skill-registry.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 .cursor/skills/api-documenter && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "api-documenter" agent skill from https://github.com/majiayu000/claude-skill-registry/tree/main/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 into .cursor/skills/api-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenter", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/majiayu000/claude-skill-registry.git --path skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add majiayu000/claude-skill-registry --skill api-documenter -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install majiayu000/claude-skill-registry api-documenter --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/majiayu000/claude-skill-registry.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 .gemini/skills/api-documenter && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "api-documenter" agent skill from https://github.com/majiayu000/claude-skill-registry/tree/main/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 into .gemini/skills/api-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenter", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install majiayu000/claude-skill-registry api-documenter

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add majiayu000/claude-skill-registry --skill api-documenter -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/majiayu000/claude-skill-registry.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 .github/skills/api-documenter && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "api-documenter" agent skill from https://github.com/majiayu000/claude-skill-registry/tree/main/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 into .github/skills/api-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenter", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add majiayu000/claude-skill-registry --skill api-documenter -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install majiayu000/claude-skill-registry api-documenter --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/majiayu000/claude-skill-registry.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 .opencode/skills/api-documenter && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "api-documenter" agent skill from https://github.com/majiayu000/claude-skill-registry/tree/main/skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 into .opencode/skills/api-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documenter", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: api-documenter
GitHub stars: 666
Used in: 1 other repo
Token cost: ~767 tokens
SKILL.md length: 303 words
Files: 2
Skills in repo: 971
Repo updated: Oct 7, 2026
First seen: Oct 7, 2026
Licence: MIT

At a glance

API documentation specialist who creates comprehensive OpenAPI/Swagger specifications and technical documentation for RESTful APIs, GraphQL schemas, and microservices architectures.

Works in 3 steps: OpenAPI Specification Creation → API Reference Documentation → API Getting Started Guide
Writing API docs
SKILL.md covers Purpose, When to Use, Quick Start and Decision Framework, plus 3 more sections
Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

API Documenter is an agent skill from majiayu000/claude-skill-registry. API documentation specialist who creates comprehensive OpenAPI/Swagger specifications and technical documentation for RESTful APIs, GraphQL schemas, and microservices architectures. Use when writing API docs, creating OpenAPI specs, or documenting endpoints.

Its SKILL.md is about 770 tokens, which your agent loads only when the skill is triggered. The skill folder holds 1 other file (for example `metadata.json`).

It sits in Backend & APIs, covering OpenAPI specifications, Technical documentation and GraphQL. It works with OpenAPI and GraphQL. The repository describes itself as: Searchable Claude Code skills catalog with source-linked guides and generated registry artifacts. The licence is MIT.

When your agent uses it

Writing API docs
Creating OpenAPI specs
Documenting endpoints

Example prompts

“/api-documenter”

Workflow steps

3 steps, taken from the step headings in SKILL.md.

OpenAPI Specification Creation
API Reference Documentation
API Getting Started Guide

What it can do on your machine

Read from SKILL.md and the folder at commit 000116a. 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
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
No URLs in SKILL.md.
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

API Documenter loads about 767 tokens when it runs. Until then it costs about 68 tokens; SKILL.md has 303 words of instructions outside code blocks.

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

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 majiayu000/claude-skill-registry at commit 000116a, republished under its MIT licence (© majiayu000). 303 words, ~767 tokens.

Download SKILL.mdSave it as .claude/skills/api-documenter/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.

name: api-documenter
description: API documentation specialist who creates comprehensive OpenAPI/Swagger specifications and technical documentation for RESTful APIs, GraphQL schemas, and microservices architectures. Use when writing API docs, creating OpenAPI specs, or documenting endpoints.

API Documenter

Purpose

Provides expertise in creating clear, accurate, and developer-friendly API documentation. Specializes in OpenAPI 3.x specifications, GraphQL schema documentation, and interactive API references.

When to Use

Writing OpenAPI/Swagger specifications
Documenting REST API endpoints
Creating GraphQL schema documentation
Building interactive API references
Writing API getting-started guides
Documenting authentication flows
Creating SDK usage examples

Quick Start

Invoke this skill when:

Writing OpenAPI/Swagger specifications
Documenting REST API endpoints
Creating GraphQL schema documentation
Building interactive API references
Writing SDK usage examples

Do NOT invoke when:

Designing API architecture (use api-designer)
Writing user-facing product docs (use technical-writer)
Creating internal system docs (use document-writer)
Building the actual API (use backend developer skills)

Decision Framework

Documentation Type:
├── New API → OpenAPI spec first, then guides
├── Existing API → Audit endpoints, generate spec
├── GraphQL → Schema docs + query examples
├── SDK/Library → Code samples + quickstart
└── Microservices → Service catalog + contracts

Core Workflows

1. OpenAPI Specification Creation

Inventory all endpoints and methods
Define request/response schemas
Document parameters and headers
Add authentication requirements
Include example requests/responses
Validate spec with linting tools

2. API Reference Documentation

Group endpoints by resource or domain
Write clear endpoint descriptions
Document all parameters with types
Provide request/response examples
Include error codes and handling
Add authentication examples

3. API Getting Started Guide

Explain authentication setup
Show first API call example
Walk through common use cases
Include SDK installation steps
Provide troubleshooting tips
Link to full reference docs

Best Practices

Use consistent terminology across all docs
Provide copy-pasteable code examples
Include both success and error responses
Version documentation with API versions
Test all code examples before publishing
Add rate limiting and quota information

Anti-Patterns

Anti-Pattern	Problem	Correct Approach
No examples	Developers guess at usage	Include request/response examples
Outdated docs	Breaks developer trust	Automate doc generation from code
Missing errors	Surprise failures in production	Document all error codes
Jargon-heavy	Confuses new developers	Use clear, simple language
No versioning	Breaking changes unclear	Version docs with API

Files

SKILL.md and 1 other file in skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 of majiayu000/claude-skill-registry.

SKILL.md
metadata.json

Open the folder on GitHubat commit 000116a

Used in 1 other repository

We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in majiayu000/claude-skill-registry, which our catalogue first saw on October 7, 2026.

NeverSight/learn-skills.devdata/skills-md/404kidwiz/claude-supercode-skills/api-documenter

Compare with similar skills

API Documenter 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.

API Documenter compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
API Documenter this skillmajiayu000/claude-skill-registry	666	1 repos	~767	Automated safety check: Pass	MIT	today
API DesignerJeffallan/claude-skills	12k	2 repos	~2k	Automated safety check: Pass	MIT	4 days ago
Distilled SDKalchemy-run/distilled	431	—	~6k	Automated safety check: Pass	Apache-2.0	today
API Contract Designrsmdt/the-startup	536	—	~1.1k	Automated safety check: Pass	MIT	2 mo ago
API Designeraiskillstore/marketplace	430	1 repos	~3.6k	Automated safety check: Pass	None	today
API Architectcuriositech/some_claude_skills	243	1 repos	~1.4k	Automated safety check: Pass	MIT	1 mo ago

Similar skills

API Designer
Jeffallan/claude-skills
Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.
12k GitHub starsUsed in 2 repos~2k tokens
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
API Contract Design
rsmdt/the-startup
REST and GraphQL API design patterns, OpenAPI/Swagger specifications, versioning strategies, and authentication patterns.
536 GitHub stars~1.1k tokensUpdated 2 mo ago
Backend & APIsAuto-check passed
API Designer
aiskillstore/marketplace
Design and document RESTful and GraphQL APIs with OpenAPI/Swagger specifications, authentication patterns, versioning strategies, and best practices.
430 GitHub starsUsed in 1 repo~3.6k tokens
Backend & APIsAuto-check passed
API Architect
curiositech/some_claude_skills
Expert API designer for REST, GraphQL, gRPC architectures. An agent skill from curiositech/some_claude_skills.
243 GitHub starsUsed in 1 repo~1.4k tokens
Backend & APIsAuto-check passed
API Design
MadAppGang/claude-code
A skill your agent uses when designing REST or GraphQL APIs, defining endpoints, implementing pagination/filtering, handling API versioning, or establishing API documentation with OpenAPI/Swagger.
283 GitHub stars~1.7k tokensUpdated 6 mo ago
Backend & APIsAuto-check passed

Questions about API Documenter

What does API Documenter do?

API documentation specialist who creates comprehensive OpenAPI/Swagger specifications and technical documentation for RESTful APIs, GraphQL schemas, and microservices architectures. API Documenter is an agent skill from majiayu000/claude-skill-registry. API documentation specialist who creates comprehensive OpenAPI/Swagger specifications and technical documentation for RESTful APIs, GraphQL schemas, and microservices architectures.

When should I use API Documenter?

API Documenter fits situations like: writing API docs; creating OpenAPI specs; documenting endpoints.

How do I install API Documenter in Claude Code?

Run `npx skills add majiayu000/claude-skill-registry --skill api-documenter -a claude-code`. Or copy the skill folder (skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 in majiayu000/claude-skill-registry) into .claude/skills/api-documenter in your project. Claude Code loads it when a task matches its description.

How do I install API Documenter in Codex?

Run `npx skills add majiayu000/claude-skill-registry --skill api-documenter -a codex`. Or copy the skill folder (skills/api/api-documenter-skill-404kidwiz-claude-supercode-ski-2 in majiayu000/claude-skill-registry) into .agents/skills/api-documenter in your project. Codex loads it when a task matches its description.

Can I use API Documenter 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 majiayu000/claude-skill-registry --skill api-documenter -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-documenter, .gemini/skills/api-documenter, .github/skills/api-documenter and .opencode/skills/api-documenter in your project.

What does API Documenter need to run?

SKILL.md names no scripts, command-line tools or credentials: API Documenter is instructions for the agent only.

Does API Documenter access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

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

API Documenter is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does API Documenter use?

About 767 tokens (SKILL.md is roughly 3.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 API Documenter?

Skills that share tags, products or a category with API Documenter: API Designer (Jeffallan/claude-skills, 12k stars), Distilled SDK (alchemy-run/distilled, 431 stars), API Contract Design (rsmdt/the-startup, 536 stars) and API Designer (aiskillstore/marketplace, 430 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Documenter?

majiayu000 (a GitHub user) maintains it in majiayu000/claude-skill-registry, which has 666 GitHub stars. The repository holds 971 skills in this directory. The repository was last updated on October 7, 2026.

Source: majiayu000/claude-skill-registry on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Install API Documenter

Facts

At a glance

What it does

When your agent uses it

Example prompts

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

API Documenter

Purpose

When to Use

Quick Start

Decision Framework

Core Workflows

1. OpenAPI Specification Creation

2. API Reference Documentation

3. API Getting Started Guide

Best Practices

Anti-Patterns

Files

Used in 1 other repository

Compare with similar skills

Similar skills

More from majiayu000/claude-skill-registry

Related

Questions about API Documenter