api-doc-generator SKILL.md skillA
api-doc-generator from jackyst0/awesome-agent-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jackyst0/awesome-agent-skills/api-doc-generator@git:20261009.fa8a292Pins git:20261009.fa8a292 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jackyst0/awesome-agent-skills
- Path
examples/api-doc-generator/SKILL.md- Versions recorded
- 2
- Latest version
- git:20261009.fa8a292, committed Oct 9, 2026
- First version recorded
- Jan 28, 2026
- Size
- 3,519 bytes
- Repository stars
- 665
- License
- CC0-1.0
Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 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 1. **识别 API 类型** - REST、GraphQL、RPC 等 2. **提取端点信息** - URL、方法、参数 3. **分析数据结构** - 请求/响应格式 4. **识别认证方式** - API Key、OAuth、JWT 等 5. **生成文档** - 按照标准格式输出 ### 文档内容 / Documentation Content 每个 API 端点应包含： - **端点路径** - URL 和 HTTP 方法 - **描述** - 功能说明 - **参数** - 路径参数、查询参数、请求体 - **响应** - 成功和错误响应示例 - **认证** - 认证要求 ### 输出格式 / Output Formats 支持以下文档格式： - Markdown（默认）- 使用 `templates/api-doc.md` 模板 - OpenAPI 3.0 YAML - API Blueprint Use `templates/api-doc.md` for Markdown output format. ### 标准模板 / Standard Template ````markdown ## API 文档 / API Documentation ### 端点概览 / Endpoint Overview | 方法 | 路径 | 描述 | |------|------|------| | GET | /api/resource | 获取资源列表 | ### 详细说明 / Details #### [方法] /path **描述**: ... **请求参数**: | 参数 | 类型 | 必需 | 描述 | …
Read the whole file at its exact version.
How to install
mdr add jackyst0/awesome-agent-skills/api-doc-generator@sha256:d88bc84fc1c551d4The line at the top of this page pins the label git:20261009.fa8a292, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_2n5jdiqpemwahnle)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Jan 28, 2026 and Oct 9, 2026, about one every 254 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261009.fa8a292 latest | 2026-10-09 | fa8a292 | 3,519 B | A | view · diff |
| git:20260128.59e71e1 | 2026-01-28 | 59e71e1 | 3,517 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (3519 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
jackyst0/awesome-agent-skills · 665 stars · license CC0-1.0 · pushed 2026-10-30 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_2n5jdiqpemwahnle GET https://markdownregistry.com/api/v1/resolve?ref=jackyst0/awesome-agent-skills/api-doc-generator GET https://markdownregistry.com/api/v1/blob/d88bc84fc1c551d45b5865fbb70da710e66a41ad07f98e1f81ca47eb6fc13ff9
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.