api-documenter

api-documenter is a skill for Claude Code from lingxling/awesome-skills-cn. It costs 39 tokens per session (1,451 once invoked), scanned A, a copy of api-documenter, MIT.

An API documentation guide centred on OpenAPI, a standard format for describing endpoints, inputs, outputs, and authentication. It also covers interactive documentation, developer portals, code examples, and SDK generation.

In plain words
What is it for?
Use it to create or update OpenAPI specifications, developer guides, SDK documentation, and interactive API reference pages.
Why use it?
Incomplete or inaccurate API documentation makes it hard for other developers to understand and use a service. This helps keep the API description, examples, and onboarding material aligned.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the agentic-awesome-skills plugin — 174 skills shipped together

Good fit Use it to create or update OpenAPI specifications, developer guides, SDK documentation, and interactive API reference pages.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/lingxling/awesome-skills-cn/api-documenter
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 lingxling/awesome-skills-cn --skill api-documenter
Clone the repo
git clone --depth 1 https://github.com/lingxling/awesome-skills-cn

Made for: Claude Code.

Or install agentic-awesome-skills, the plugin that ships this one along with the rest of its 174 skills.

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-documenter

README.md
[![agentmods](https://agentmods.dev/badge/skills/lingxling/awesome-skills-cn/api-documenter/github.svg)](https://agentmods.dev/skills/lingxling/awesome-skills-cn/api-documenter)
Your own site
<a href="https://agentmods.dev/skills/lingxling/awesome-skills-cn/api-documenter"><img src="https://agentmods.dev/badge/skills/lingxling/awesome-skills-cn/api-documenter/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-documenter

Your own site · 80×15
<a href="https://agentmods.dev/skills/lingxling/awesome-skills-cn/api-documenter"><img src="https://agentmods.dev/badge/skills/lingxling/awesome-skills-cn/api-documenter.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 39 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,451 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 100% 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.00039 $0.01451
Opus 5.5 $0.00016 $0.00580
Sonnet 5.5 $0.00008 $0.00290
Haiku 4.5 $0.00004 $0.00145

Measured 16d ago against content hash 8bd372644f41, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

api-documenter 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 16d 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.

- Automated testing of code examples and curl commands
Origin

This is a copy

100% identical to api-documenter — 0 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.

antigravity-awesome-skills/plugins/agentic-awesome-skills-claude/skills/api-documenter/SKILL.md · 188 lines

How it starts

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

You are an expert API documentation specialist mastering modern developer experience through comprehensive, interactive, and AI-enhanced documentation.

Use this skill when

  • Creating or updating OpenAPI/AsyncAPI specifications
  • Building developer portals, SDK docs, or onboarding flows
  • Improving API documentation quality and discoverability
  • Generating code examples or SDKs from API specs

Do not use this skill when

  • You only need a quick internal note or informal summary
  • The task is pure backend implementation without docs
  • There is no API surface or spec to document

Instructions

  1. Identify target users, API scope, and documentation goals.
  2. Create or validate specifications with examples and auth flows.
  3. Build interactive docs and ensure accuracy with tests.
  4. Plan maintenance, versioning, and migration guidance.

Purpose

Expert API documentation specialist focusing on creating world-class developer experiences through comprehensive, interactive, and accessible API documentation. Masters modern documentation tools, OpenAPI 3.1+ standards, and AI-powered documentation workflows while ensuring documentation drives API adoption and reduces developer integration time.

Capabilities

Modern Documentation Standards

  • OpenAPI 3.1+ specification authoring with advanced features
  • API-first design documentation with contract-driven development
  • AsyncAPI specifications for event-driven and real-time APIs
  • GraphQL schema documentation and SDL best practices
  • JSON Schema validation and documentation integration
  • Webhook documentation with payload examples and security considerations
  • API lifecycle documentation from design to deprecation

AI-Powered Documentation Tools

  • AI-assisted content generation with tools like Mintlify and ReadMe AI
  • Automated documentation updates from code comments and annotations
  • Natural language processing for developer-friendly explanations
  • AI-powered code example generation across multiple languages
  • Intelligent content suggestions and consistency checking
  • Automated testing of documentation examples and code snippets
  • Smart content translation and localization workflows

Read the full file on GitHub · 188 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. 16d ago First seen · 188 lines · 39 tokens per session scan A 8bd372644f41

Subscribe to this mod's changes

api-documenter is a skill published in the GitHub repository lingxling/awesome-skills-cn (317 stars, last pushed 15d ago), licensed MIT. It adds 39 tokens to every session and 1,451 once invoked, about $0.0002 per session on Opus 5.5. A static security scan graded it A with 1 finding (makes network calls). It is 100% identical to api-documenter, differing in 0 lines, and is treated as a copy.

Related

Other skills, from other repositories

api-design

Design production-grade REST, GraphQL, gRPC, and Python library APIs with correct schemas, error contracts, auth, and versioning. Use when the user asks to design an API, define endpoints, create an OpenAPI/Swagger spec, design a GraphQL schema, build a gRPC service, model request/response with Pydantic, add…

viktorbezdek/skillstack · 114 tokens

content-modelling

Design CMS content models — content types, fields, editorial workflows, governance rules, and COPE (Create Once, Publish Everywhere) patterns — for structured, multi-channel publishing. Use when the user asks to design a content model, define content types in a CMS, structure fields for editorial content, plan a…

viktorbezdek/skillstack · 114 tokens

nodejs-development

Node.js development guidelines covering Payload CMS, Vue.js with TypeScript, and general TypeScript best practices.

Mindrally/skills · 24 tokens

dotnet

Guidelines for .NET backend development with C#, ASP.NET Core, and Entity Framework Core.

Mindrally/skills · 21 tokens

microservices

Guidelines for building production-grade microservices with FastAPI/Python and Go, covering serverless patterns, clean architecture, observability, and resilience.

Mindrally/skills · 33 tokens

voice-ai-realtime-agent

Expert guide for Ultra-Low Latency Conversational Voice AI (<300ms), WebRTC bidirectional streaming, OpenAI Realtime API, Gemini Multimodal Live Audio, LiveKit Agents, and Semantic VAD / Panduan ahli AI suara percakapan real-time berlatensi ultra-rendah.

roedyrustam/vibes-plug · 68 tokens