api-documentation

api-documentation is a skill for Claude Code from ratnesh-maurya/cursor-claude-personas. It costs 23 tokens per session (788 once invoked), scanned A, a copy of api-documentation, MIT.

A workflow for documenting an API, the set of rules that lets software communicate with other software. It covers OpenAPI specifications, developer guides, examples, authentication, errors, and rate limits.

In plain words
What is it for?
Use it to inventory endpoints, describe requests and responses, create an OpenAPI specification, document security settings, and prepare developer documentation.
Why use it?
It provides a structured way to turn an undocumented or changing API into information that other developers can understand and use.

Skill for Claude Code

Written for Claude Code: installed under .claude/.

Good fit Use it to inventory endpoints, describe requests and responses, create an OpenAPI specification, document security settings, and prepare developer documentation.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/ratnesh-maurya/cursor-claude-personas/api-documentation
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add ratnesh-maurya/cursor-claude-personas --skill api-documentation
Clone the repo
git clone --depth 1 https://github.com/ratnesh-maurya/cursor-claude-personas

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for api-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/ratnesh-maurya/cursor-claude-personas/api-documentation/github.svg)](https://agentmods.dev/skills/ratnesh-maurya/cursor-claude-personas/api-documentation)
Your own site
<a href="https://agentmods.dev/skills/ratnesh-maurya/cursor-claude-personas/api-documentation"><img src="https://agentmods.dev/badge/skills/ratnesh-maurya/cursor-claude-personas/api-documentation/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for api-documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/ratnesh-maurya/cursor-claude-personas/api-documentation"><img src="https://agentmods.dev/badge/skills/ratnesh-maurya/cursor-claude-personas/api-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 23 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 788 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.
Origin 95% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00023 $0.00788
Opus 5 $0.00012 $0.00394
Sonnet 5 $0.00005 $0.00158
Haiku 4.5 $0.00002 $0.00079

Measured 9d ago against content hash dc68be9b642f, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

api-documentation scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

3. Add curl examples
Origin

This is a copy

95% identical to api-documentation — 5 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.claude/skills/api-documentation/SKILL.md · 164 lines

How it starts

The opening of the file, as written. The whole thing — 164 lines — stays where its author put it; the contents beside it link to each section on GitHub.

API Documentation Workflow

Overview

Specialized workflow for creating comprehensive API documentation including OpenAPI/Swagger specs, developer guides, code examples, and interactive documentation.

When to Use This Workflow

Use this workflow when:

  • Creating API documentation
  • Generating OpenAPI specs
  • Writing developer guides
  • Adding code examples
  • Setting up API portals

Workflow Phases

Phase 1: API Discovery

Skills to Invoke
  • api-documenter - API documentation
  • api-design-principles - API design
Actions
  1. Inventory endpoints
  2. Document request/response
  3. Identify authentication
  4. Map error codes
  5. Note rate limits
Copy-Paste Prompts
Use @api-documenter to discover and document API endpoints

Phase 2: OpenAPI Specification

Skills to Invoke
  • openapi-spec-generation - OpenAPI
  • api-documenter - API specs
Actions
  1. Create OpenAPI schema
  2. Define paths
  3. Add schemas
  4. Configure security
  5. Add examples
Copy-Paste Prompts
Use @openapi-spec-generation to create OpenAPI specification

Phase 3: Developer Guide

Skills to Invoke
  • api-documentation-generator - Documentation
  • documentation-templates - Templates
Actions
  1. Create getting started
  2. Write authentication guide
  3. Document common patterns
  4. Add troubleshooting
  5. Create FAQ
Copy-Paste Prompts
Use @api-documentation-generator to create developer guide

Phase 4: Code Examples

Skills to Invoke
  • api-documenter - Code examples
  • tutorial-engineer - Tutorials
Actions
  1. Create example requests
  2. Write SDK examples
  3. Add curl examples
  4. Create tutorials
  5. Test examples
Copy-Paste Prompts
Use @api-documenter to generate code examples

Phase 5: Interactive Docs

Skills to Invoke
  • api-documenter - Interactive docs
Actions
  1. Set up Swagger UI
  2. Configure Redoc
  3. Add try-it functionality
  4. Test interactivity
  5. Deploy docs
Copy-Paste Prompts
Use @api-documenter to set up interactive documentation

Read the full file on GitHub · 164 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 9d ago First seen · 164 lines · 23 tokens per session scan A dc68be9b642f

Subscribe to this mod's changes

api-documentation is a skill published in the GitHub repository ratnesh-maurya/cursor-claude-personas (8 stars, last pushed 5mo ago), licensed MIT. It adds 23 tokens to every session and 788 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). It is 95% identical to api-documentation, differing in 5 lines, and is treated as a copy.

Related

Other skills, from other repositories

sdd-apply

Skill "sdd-apply" from Gentleman-Programming/gentle-ai, covering execution role, language domain contract, purpose, what you receive and execution and persistence contract.

Gentleman-Programming/gentle-ai · 0 tokens

solr-extending

To build Solr plugins: SearchComponent, QParser, URP, DocTransformer.

griddynamics/rosetta · 23 tokens

spring-cloud-circuitbreaker

Resilience patterns with Spring Cloud Circuit Breaker and Resilience4j. Covers circuit breaker, retry, rate limiter, bulkhead, and fallback patterns. USE WHEN: user mentions "circuit breaker", "resilience4j", "fallback", "retry pattern", "rate limiter", "bulkhead", "fault tolerance Spring" DO NOT USE FOR: basic HTTP…

claude-dev-suite/claude-dev-suite · 100 tokens

spring-rest

Spring REST Controller patterns. Covers ResponseEntity, exception handling, validation, HATEOAS, content negotiation, and async controllers. USE WHEN: user mentions "spring rest", "@RestController", "ResponseEntity", "REST API Spring", "exception handling Spring", "@ControllerAdvice" DO NOT USE FOR: GraphQL - use…

claude-dev-suite/claude-dev-suite · 104 tokens

graphql

GraphQL API design. Covers schema, queries, mutations, and resolvers. Use when building or consuming GraphQL APIs. USE WHEN: user mentions "GraphQL", "schema definition", "resolvers", "mutations", "queries", "DataLoader", "N+1 problem", asks about "how to design GraphQL API", "GraphQL schema", "GraphQL…

claude-dev-suite/claude-dev-suite · 128 tokens

openapi-codegen

OpenAPI client code generation. Covers openapi-typescript, openapi-generator-cli, swagger-typescript-api, and trpc-openapi. Use for generating type-safe API clients. USE WHEN: user mentions "OpenAPI codegen", "generate API client", "openapi-typescript", "swagger-typescript-api", "openapi-generator", asks about…

claude-dev-suite/claude-dev-suite · 139 tokens