📄

WritingShell

API Doc Generator

API Doc Generator is a Writing skill for Claude Code, published by JackyST0 in awesome-agent-skills.

624 stars109 forkson JackyST0/awesome-agent-skillsAdded 2026/08/24Repository updated 2026/08/24

View source on GitHub Download repo ZIP

agent-skillsaiawesomeawesome-listclaudecopilotcursor

Install in seconds

Install API Doc Generator

Copy API Doc Generator into your Claude Code skills folder. Run the command in your terminal, or review the source on GitHub before installing.

terminal

npx degit https://github.com/JackyST0/awesome-agent-skills/tree/main/examples/api-doc-generator ~/.claude/skills/api-doc-generator

Requires Node.js. Downloads this skill only — not the rest of the repository — into your Claude Code skills folder.

Without Node.js

git clone https://github.com/JackyST0/awesome-agent-skills.git

Clones the whole repository, then copy the skill’s own directory into your skills folder yourself.

In this catalog

Source file: examples/api-doc-generator/SKILL.md in JackyST0/awesome-agent-skills
Installs to: ~/.claude/skills/api-doc-generator
Collection: One of 5 skills cataloged from this repository
Category: Writing — 1012 skills

What API Doc Generator does

API Doc Generator creates API documentation from source code for REST, GraphQL, and other API styles. Use it when you need endpoint descriptions, parameters, responses, or OpenAPI/Swagger output.

API Doc Generator is cataloged under Writing on DirSkills. API Doc Generator comes from a repository tagged agent-skills, ai, awesome, awesome-list and claude.

Documentation

README

Excerpt

API Doc Generator

根据代码生成 API 文档，支持 REST API、GraphQL 及多种文档格式。

Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.

When to Use

当用户请求以下操作时使用此 skill：

生成 API 文档 / Generate API documentation
创建接口文档 / Create interface documentation
编写 API 说明 / Write API descriptions
生成 OpenAPI/Swagger 规范 / Generate OpenAPI/Swagger specs

Instructions

分析步骤 / Analysis Steps

识别 API 类型 - REST、GraphQL、RPC 等
提取端点信息 - URL、方法、参数
分析数据结构 - 请求/响应格式
识别认证方式 - API Key、OAuth、JWT 等
生成文档 - 按照标准格式输出

文档内容 / Documentation Content

每个 API 端点应包含：

端点路径 - URL 和 HTTP 方法
描述 - 功能说明
参数 - 路径参数、查询参数、请求体
响应 - 成功和错误响应示例
认证 - 认证要求

输出格式 / Output Formats

This is the opening of the README. Read the full README on GitHub.

Commands API Doc Generator provides

Slash commands named in this skill’s SKILL.md, listed in the order they first appear.

/path
/users

Frequently asked about API Doc Generator

What else does JackyST0 publish alongside API Doc Generator?
API Doc Generator is one of 5 skills that DirSkills catalogs from JackyST0/awesome-agent-skills, the repository it ships in. Its siblings there include Code Review, Debug Helper and Git Commit. Each one is a separate skill with its own page in this directory, installs the same way API Doc Generator does, and is maintained by JackyST0 in that same repository. The rest of the collection is listed on the JackyST0/awesome-agent-skills page.
How does API Doc Generator compare to other Writing skills?
API Doc Generator ranks #661 by stars among the 1012 Writing skills in this catalog. The most-starred ones next to it are Article Writing, Social Media Content Calendar and Knowledge Comic Creator. DirSkills ranks by the star count of the repository each skill ships in, so that order reflects how popular those repositories are rather than any review of API Doc Generator against them. Open each page to compare what they document and how they install.

More from JackyST0/awesome-agent-skills

API Doc Generator is one of 5 skills cataloged on DirSkills from JackyST0/awesome-agent-skills.

See all 5 skills →

Code Review

Code Review examines code for syntax, logic, security, performance, and style issues. Use it when you want a review report with problems found and concrete improvement suggestions.

Debug Helper

Debug Helper analyzes error messages, stack traces, and code to identify likely root causes and suggest fixes. Use it when troubleshooting bugs, exceptions, or failing runtime behavior.

Git Commit

Git Commit generates Conventional Commit messages from code changes. Use it when you need a commit title, body, or type based on a diff or git status.

Unit Test Generator

Unit Test Generator automatically creates unit tests from source code for multiple languages and frameworks. Use it when you need tests for functions, classes, edge cases, or better coverage.

More Writing skills

API Doc Generator is one of 1012 Writing skills cataloged on DirSkills, ranked #661 by stars among them.

Browse all Writing skills →

Article Writing

Article Writing writes articles, guides, blog posts, tutorials, newsletter issues, and other long-form content in a distinctive voice derived from supplied examples or brand guidance. Use it when you want polished written content longer than a paragraph, especially when voice consistency, structure, and credibility matter.

Social Media Content Calendar

Social Media Content Calendar plans multi-platform social campaigns from briefs through scheduling and verified publishing. Use it when building a calendar, turning launches into posts, or repurposing content across X, LinkedIn, Instagram, and TikTok.

Knowledge Comic Creator

Knowledge Comic Creator generates educational, biography, and tutorial comics from user-provided text, URLs, or topics, with configurable art styles, tones, layouts, and languages. Use it when a user asks for a knowledge comic, 知识漫画, or Logicomix-style explanation.