api-documentation-generator

api-documentation-generator is a skill for Claude Code from lingxling/awesome-skills-cn. It costs 25 tokens per session (2,847 once invoked), scanned B, a copy of api-documentation-generator, MIT.

A tool for creating API documentation from a codebase. It documents web endpoints, GraphQL operations, or WebSocket connections with details such as parameters, examples, authentication, errors, and usage guidance.

In plain words
What is it for?
Use it to document new or existing APIs, generate OpenAPI or Swagger specifications, describe routes and response formats, and prepare onboarding material.
Why use it?
It reduces the work of keeping API instructions complete and understandable as the code changes. Clear documentation also helps new and external developers use an API.

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 document new or existing APIs, generate OpenAPI or Swagger specifications, describe routes and response formats, and prepare onboarding material.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/lingxling/awesome-skills-cn/api-documentation-generator
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-documentation-generator
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-documentation-generator

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/lingxling/awesome-skills-cn/api-documentation-generator"><img src="https://agentmods.dev/badge/skills/lingxling/awesome-skills-cn/api-documentation-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 25 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,847 The whole file, excluding the scripts and references it only reads on demand.
Security scan B 2 findings. 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.00025 $0.02847
Opus 5.5 $0.00010 $0.01139
Sonnet 5.5 $0.00005 $0.00569
Haiku 4.5 $0.00003 $0.00285

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

Security

Grade B, and why

api-documentation-generator scanned grade B with 2 findings 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 19d 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.

Sends data to an external URLmediumData exfiltration

A POST to an outside endpoint may be telemetry or may be exfiltration; either way the mod talks to somewhere, and you should know where.

response = requests.post( 'https://api.example.com/api/v1/users',

Makes network callslowCapability

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

curl -X POST https://api.example.com/api/v1/users \
Origin

This is a copy

100% identical to api-documentation-generator — 4 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-documentation-generator/SKILL.md · 493 lines

How it starts

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

API Documentation Generator

Overview

Automatically generate clear, comprehensive API documentation from your codebase. This skill helps you create professional documentation that includes endpoint descriptions, request/response examples, authentication details, error handling, and usage guidelines.

Perfect for REST APIs, GraphQL APIs, and WebSocket APIs.

When to Use This Skill

  • Use when you need to document a new API
  • Use when updating existing API documentation
  • Use when your API lacks clear documentation
  • Use when onboarding new developers to your API
  • Use when preparing API documentation for external users
  • Use when creating OpenAPI/Swagger specifications

How It Works

Step 1: Analyze the API Structure

First, I'll examine your API codebase to understand:

  • Available endpoints and routes
  • HTTP methods (GET, POST, PUT, DELETE, etc.)
  • Request parameters and body structure
  • Response formats and status codes
  • Authentication and authorization requirements
  • Error handling patterns

Step 2: Generate Endpoint Documentation

For each endpoint, I'll create documentation including:

Endpoint Details:

  • HTTP method and URL path
  • Brief description of what it does
  • Authentication requirements
  • Rate limiting information (if applicable)

Request Specification:

  • Path parameters
  • Query parameters
  • Request headers
  • Request body schema (with types and validation rules)

Response Specification:

  • Success response (status code + body structure)
  • Error responses (all possible error codes)
  • Response headers

Code Examples:

  • cURL command
  • JavaScript/TypeScript (fetch/axios)
  • Python (requests)
  • Other languages as needed

Step 3: Add Usage Guidelines

I'll include:

  • Getting started guide
  • Authentication setup
  • Common use cases
  • Best practices
  • Rate limiting details
  • Pagination patterns
  • Filtering and sorting options

Step 4: Document Error Handling

Clear error documentation including:

  • All possible error codes
  • Error message formats
  • Troubleshooting guide
  • Common error scenarios and solutions

Read the full file on GitHub · 493 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. 19d ago First seen · 493 lines · 25 tokens per session scan B 7f31a889c229

Subscribe to this mod's changes

api-documentation-generator is a skill published in the GitHub repository lingxling/awesome-skills-cn (321 stars, last pushed 19d ago), licensed MIT. It adds 25 tokens to every session and 2,847 once invoked, about $0.0001 per session on Opus 5.5. A static security scan graded it B with 2 findings (sends data to an external url, makes network calls). It is 100% identical to api-documentation-generator, differing in 4 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