API Documenter
majiayu000/claude-skill-registry
API documentation specialist who creates comprehensive OpenAPI/Swagger specifications and technical documentation for RESTful APIs, GraphQL schemas, and microservices architectures.
Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs.
Install API Documentation Writer
$ npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install OneWave-AI/claude-skills api-documentation-writer --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/OneWave-AI/claude-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/api-documentation-writer .claude/skills/api-documentation-writer && rm -rf skills-srcUse ~/.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/
Install the "api-documentation-writer" agent skill from https://github.com/OneWave-AI/claude-skills/tree/main/api-documentation-writer into .claude/skills/api-documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documentation-writer", 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 install https://github.com/OneWave-AI/claude-skills/tree/main/api-documentation-writerType 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.
$ npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install OneWave-AI/claude-skills api-documentation-writer --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/OneWave-AI/claude-skills.git skills-src && mkdir -p .agents/skills && cp -r skills-src/api-documentation-writer .agents/skills/api-documentation-writer && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "api-documentation-writer" agent skill from https://github.com/OneWave-AI/claude-skills/tree/main/api-documentation-writer into .agents/skills/api-documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documentation-writer", 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.
$ npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install OneWave-AI/claude-skills api-documentation-writer --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/OneWave-AI/claude-skills.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/api-documentation-writer .cursor/skills/api-documentation-writer && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "api-documentation-writer" agent skill from https://github.com/OneWave-AI/claude-skills/tree/main/api-documentation-writer into .cursor/skills/api-documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documentation-writer", 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 https://github.com/OneWave-AI/claude-skills.git --path api-documentation-writer--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install OneWave-AI/claude-skills api-documentation-writer --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/OneWave-AI/claude-skills.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/api-documentation-writer .gemini/skills/api-documentation-writer && rm -rf skills-srcUse ~/.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/
Install the "api-documentation-writer" agent skill from https://github.com/OneWave-AI/claude-skills/tree/main/api-documentation-writer into .gemini/skills/api-documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documentation-writer", 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.
$ gh skill install OneWave-AI/claude-skills api-documentation-writerInstalls 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).
$ npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/OneWave-AI/claude-skills.git skills-src && mkdir -p .github/skills && cp -r skills-src/api-documentation-writer .github/skills/api-documentation-writer && rm -rf skills-srcUse ~/.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/
Install the "api-documentation-writer" agent skill from https://github.com/OneWave-AI/claude-skills/tree/main/api-documentation-writer into .github/skills/api-documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documentation-writer", 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.
$ npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install OneWave-AI/claude-skills api-documentation-writer --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/OneWave-AI/claude-skills.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/api-documentation-writer .opencode/skills/api-documentation-writer && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "api-documentation-writer" agent skill from https://github.com/OneWave-AI/claude-skills/tree/main/api-documentation-writer into .opencode/skills/api-documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-documentation-writer", 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-documentation-writer- GitHub stars
- 322
- Token cost
- ~541 tokens
- SKILL.md length
- 215 words
- Files
- 4 (incl. references)
- Skills in repo
- 91
- Repo updated
- First seen
- Licence
- MIT
At a glance
Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs.
- Works in 6 steps: Gather API information. Determine the… → Build the documentation structure. Cover… → Generate the output. Follow… → …
- Users need to document APIs
- SKILL.md covers Contents, Workflow and Example Triggers
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
API Documentation Writer is an agent skill from OneWave-AI/claude-skills. Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. Creates OpenAPI/Swagger specs, REST API docs, and developer-friendly reference materials. Use when users need to document APIs, create technical references, or write developer documentation.
Its SKILL.md is about 540 tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files, including reference files (for example `references/best-practices.md`, `references/documentation-structure.md` and `references/output-template.md`).
It sits in Backend & APIs, covering Technical documentation, OpenAPI specifications and REST APIs. It works with OpenAPI and GraphQL. The repository describes itself as: 200+ production-ready Claude Code skills for sales, marketing, design, engineering, and AI agent architecture. Built and maintained by OneWave AI. The licence is MIT.
When your agent uses it
- Users need to document APIs
- Create technical references
- Write developer documentation
Example prompts
- “/api-documentation-writer”
Workflow steps
6 steps, taken from the first numbered list in SKILL.md.
- Gather API information. Determine the API type (REST, GraphQL, WebSocket, gRPC), authentication method (API key, OAuth, JWT), base URL and…
- Build the documentation structure. Cover every section in references/documentation-structure.md, ordering the most common operations first.
- Generate the output. Follow references/output-template.md for REST APIs; adapt to schema, query, mutation, and subscription examples for…
- Document errors and rate limits. Include the standard error response format, common error codes, troubleshooting guidance, limits, headers…
- Provide code samples in multiple languages (curl, JavaScript, Python) and link SDKs, Postman collections, or OpenAPI specs where available.
- Verify quality against the checklist in references/best-practices.md before delivering.
What it can do on your machine
Read from SKILL.md and the folder at commit fc5b785. 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 Documentation Writer loads about 541 tokens when it runs, and up to ~2k if it reads all its reference files. Until then it costs about 91 tokens; SKILL.md has 215 words of instructions outside code blocks.
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 OneWave-AI/claude-skills at commit fc5b785, republished under its MIT licence (© OneWave-AI). 215 words, ~541 tokens.
Download SKILL.mdSave it as
.claude/skills/api-documentation-writer/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.- name
- api-documentation-writer
- description
- Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. Creates OpenAPI/Swagger specs, REST API docs, and developer-friendly reference materials. Use when users need to document APIs, create technical references, or write developer documentation.
API Documentation Writer
Generate comprehensive, developer-friendly API documentation.
Contents
references/documentation-structure.md— every section to cover (overview, auth, endpoints, errors, rate limits, SDKs, webhooks, GraphQL)references/output-template.md— canonical REST Markdown template with worked examplesreferences/best-practices.md— best practices, developer-experience tips, and the output quality checklist
Workflow
Gather API information. Determine the API type (REST, GraphQL, WebSocket, gRPC), authentication method (API key, OAuth, JWT), base URL and versioning strategy, available endpoints and their purposes, request/response formats, and any rate limiting or usage restrictions.
Build the documentation structure. Cover every section in
references/documentation-structure.md, ordering the most common operations first.Generate the output. Follow
references/output-template.mdfor REST APIs; adapt to schema, query, mutation, and subscription examples for GraphQL. Replace all placeholders with realistic example data and show both request and response.Document errors and rate limits. Include the standard error response format, common error codes, troubleshooting guidance, limits, headers to check, and how to handle
429responses.Provide code samples in multiple languages (curl, JavaScript, Python) and link SDKs, Postman collections, or OpenAPI specs where available.
Verify quality against the checklist in
references/best-practices.mdbefore delivering.
Example Triggers
- "Write API documentation for my REST endpoints"
- "Create OpenAPI spec for my API"
- "Document this GraphQL schema"
- "Generate developer docs for my webhook API"
- "Write authentication guide for API"
© OneWave-AI, 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 api-documentation-writer of OneWave-AI/claude-skills.
- SKILL.md
- references/best-practices.md
- references/documentation-structure.md
- references/output-template.md
Open the folder on GitHubat commit fc5b785
Compare with similar skills
API Documentation Writer 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.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| API Documentation Writer this skillOneWave-AI/claude-skills | 322 | — | ~541 | Automated safety check: Pass | MIT | |
| API Documentermajiayu000/claude-skill-registry | 666 | 1 repos | ~767 | Automated safety check: Pass | MIT | |
| OpenAPI Spec Generationwshobson/agents | 40k | 9 repos | ~511 | Automated safety check: Pass | MIT | |
| API DesignerJeffallan/claude-skills | 12k | 2 repos | ~2k | Automated safety check: Pass | MIT | |
| Use Yaakmountain-loop/yaak | 19k | — | ~1.9k | Automated safety check: Pass | MIT | |
| Distilled SDKalchemy-run/distilled | 431 | — | ~6k | Automated safety check: Pass | Apache-2.0 |
Similar skills
OpenAPI Spec Generation
wshobson/agents
Create, validate and maintain OpenAPI 3.1 specs for REST APIs, whether designed first or generated from existing code, and use them for docs and client SDKs.
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.
Use Yaak
mountain-loop/yaak
A skill your agent uses when the user mentions Yaak, a Yaak workspace, or the yaak command, or asks to call, hit, or smoke test HTTP/REST endpoints, save or organize API requests for reuse or manual…
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…
API Contract Design
rsmdt/the-startup
REST and GraphQL API design patterns, OpenAPI/Swagger specifications, versioning strategies, and authentication patterns.
More from OneWave-AI/claude-skills
All 91 skills in this repoCRM Data Cleanup
OneWave-AI/claude-skills
Finds duplicate and junk records in a CRM CSV export with fuzzy matching, normalizes fields and writes a reviewable merge plan plus import-ready files without touching the live CRM.
Design Export Repair
OneWave-AI/claude-skills
Repairs broken decks and PDFs exported from Claude Design or similar AI deck generators: clipped text, wrong fonts and corrupted .pptx package structure.
Bi Measure Builder
OneWave-AI/claude-skills
Writes, explains, debugs, and optimizes BI calculations - Power BI / Fabric DAX measures and calculated columns, Tableau calculated fields (FIXED/INCLUDE/EXCLUDE LOD expressions, table…
Bookkeeping Close
OneWave-AI/claude-skills
Categorizes transactions, reconciles bank and card statements to the ledger, works a month-end checklist and prepares a close package, without ever forcing a balance.
CSV and Excel Merger
OneWave-AI/claude-skills
Combines CSV, TSV and Excel files into one verified table with pandas, by stacking or joining, mapping columns, normalizing keys and removing duplicates.
Sec Filing Puller
OneWave-AI/claude-skills
Pulls financial statement numbers for US public companies straight from SEC EDGAR's free official XBRL APIs (companyfacts, companyconcept, frames, submissions) into a cited table.
Related
Categories
Questions about API Documentation Writer
What does API Documentation Writer do?
Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs. API Documentation Writer is an agent skill from OneWave-AI/claude-skills. Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs.
When should I use API Documentation Writer?
API Documentation Writer fits situations like: users need to document APIs; create technical references; write developer documentation.
How do I install API Documentation Writer in Claude Code?
Run `npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a claude-code`. Or copy the skill folder (api-documentation-writer in OneWave-AI/claude-skills) into .claude/skills/api-documentation-writer in your project. Claude Code loads it when a task matches its description.
How do I install API Documentation Writer in Codex?
Run `npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a codex`. Or copy the skill folder (api-documentation-writer in OneWave-AI/claude-skills) into .agents/skills/api-documentation-writer in your project. Codex loads it when a task matches its description.
Can I use API Documentation Writer 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 OneWave-AI/claude-skills --skill api-documentation-writer -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-documentation-writer, .gemini/skills/api-documentation-writer, .github/skills/api-documentation-writer and .opencode/skills/api-documentation-writer in your project.
What does API Documentation Writer need to run?
SKILL.md names no scripts, command-line tools or credentials: API Documentation Writer is instructions for the agent only.
Does API Documentation Writer 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 Documentation Writer 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 Documentation Writer use?
API Documentation Writer 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 Documentation Writer use?
About 541 tokens (SKILL.md is roughly 2.2k 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.5k tokens, read only when the agent opens those files.
What are the alternatives to API Documentation Writer?
Skills that share tags, products or a category with API Documentation Writer: API Documenter (majiayu000/claude-skill-registry, 666 stars), OpenAPI Spec Generation (wshobson/agents, 40k stars), API Designer (Jeffallan/claude-skills, 12k stars) and Use Yaak (mountain-loop/yaak, 19k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains API Documentation Writer?
OneWave-AI (a GitHub organization) maintains it in OneWave-AI/claude-skills, which has 322 GitHub stars. The repository holds 91 skills in this directory. The repository was last updated on October 2, 2026.
Source: OneWave-AI/claude-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.