← All skills

api-docs

75 / 100 · Review before installing

Check before installing. Some of what it can do is expected: a coding skill usually runs build and test commands.

By Everyone-Needs-A-Copilot/claude-copilot (GitHub) · coding · 14 stars · scanned at commit 0f57aa5

API documentation patterns covering REST endpoint specs, auth flows, error handling, OpenAPI/Swagger completeness, api-first design, and versioning best practices — plus deterministic OpenAPI/Swagger coverage linting script. Use proactively when documenting REST API endpoints, reviewing OpenAPI or Swagger specs for completeness, ensuring auth flows, error codes, and examples are documented, or running an api-first design review. Run the linter for deterministic coverage scoring.

Works with any agent that supports SKILL.md skills.

What this skill can do

Safer alternatives

Low-risk skills in the same category (coding) that look related. Check that one does what you need.

• 95 Low riskapi-documentation-writerOneWave-AI/claude-skills · 421 stars
• 90 Low riskapi-validatordiegosouzapw/awesome-omni-skill · 66 stars
• 100 Low riskapi-design-principlesActiver007/ordinary-claude-skills · 14 stars

Install

Paste this into your terminal. It downloads exactly the version we scanned, not whatever is newest.

if [ -e ~/.agents/skills/'api-docs' ] || [ -L ~/.agents/skills/'api-docs' ]; then echo 'A skill folder named api-docs already exists — not replacing it' >&2; false; else d=$(mktemp -d) && git clone --quiet --filter=blob:none --no-checkout 'https://github.com/Everyone-Needs-A-Copilot/claude-copilot' "$d" && git -C "$d" checkout --quiet '0f57aa588a5c2c7da021b976edc1b176ea602022' -- '.claude/skills/documentation/api-docs' && mkdir -p ~/.agents/skills && cp -R "$d"/'.claude/skills/documentation/api-docs' ~/.agents/skills/'api-docs' && rm -rf "$d"; fi

Codex reads ~/.agents/skills directly. For Claude Code, Cursor, Copilot, Gemini CLI, Antigravity or OpenCode, also link it. For Claude Code: ln -s ~/.agents/skills/'api-docs' ~/.claude/skills/'api-docs' (other agents: ~/.cursor/skills, ~/.copilot/skills, ~/.gemini/skills, ~/.gemini/config/skills, ~/.config/opencode/skills). Or install through the finder skill, which does both.

Badge for your README

The badge for Everyone-Needs-A-Copilot/claude-copilot shows the score of its lowest-scoring skill.

[![SkillTrust](https://zalavijaysinh.github.io/skilltrust/badges/Everyone-Needs-A-Copilot/claude-copilot.svg)](https://zalavijaysinh.github.io/skilltrust/repos/Everyone-Needs-A-Copilot/claude-copilot/)

Score history