API Documentation

API Documentation: OpenAPI/Swagger specs, Postman collections, API reference patterns, and client SDK docs

492 stars 68 forksSoftware Development

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add cosmicstack-labs/mercury-agent-skills --skill api-documentation
Manual install
git clone --depth 1 https://github.com/cosmicstack-labs/mercury-agent-skills.git /tmp/mercury-agent-skills
mkdir -p ~/.claude/skills
cp -r /tmp/mercury-agent-skills/categories/development/api-documentation ~/.claude/skills/api-documentation

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# API Documentation

Document APIs that developers love to integrate with — complete, accurate, and testable from the spec itself.

## Core Principles

### 1. The Spec Is the Source of Truth
Your OpenAPI/Swagger specification should be the single source of truth for your API. Generate documentation, client libraries, and test suites from it. Never let docs drift from the spec.

### 2. Document the Experience, Not Just the Endpoints
Good API docs don't just list endpoints — they explain authentication, error handling, rate limits, pagination, and common workflows. Developer experience is documentation.

### 3. Every Endpoint Needs a Runnable Example
Every API endpoint should have at least one complete request/response example that a developer can copy, paste, and run. Show both success and error responses.

### 4. Version Everything, Deprecate Gracefully
APIs evolve. Documentation must clearly indicate which versions are active, deprecated, and sunset. Give consumers time to migrate with clear migration guides.

---

## API Documentation Maturity Model

| Level | Completeness | Accuracy | Interactivity | Versioning | Client Generation |
|-------|-------------|----------|---------------|------------|-------------------|
| **1: Minimal** | Endpoints listed only | Often outdated | None (static text) | No versioning | None |
| **2: Basic** | Endpoints + parameters | Occasionally accurate | Static examples | One active version | Manual SDK examples |
Read the full skill on GitHub

Details

Skill name
api-documentation
Path
categories/development/api-documentation/SKILL.md
License
MIT
Repo updated
25 August 2026

FAQ

What does the API Documentation skill do?

API Documentation: OpenAPI/Swagger specs, Postman collections, API reference patterns, and client SDK docs

How do I install the API Documentation skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add cosmicstack-labs/mercury-agent-skills --skill api-documentation. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is API Documentation popular?

It lives in cosmicstack-labs/mercury-agent-skills, which has 492 GitHub stars and 68 forks.

Related skills

Browse the most popular Claude skills, all software development skills, or write your own with the skills generator.