Api doc generator

Skill skillsmith-dev/ai-skills/skills/api-doc-generator

27 AI skill tools MIT License

Install

npx -y skills add skillsmith-dev/ai-skills --skill api-doc-generator

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

API文档自动生成助手从代码接口定义或描述中生成规范的RESTful API文档包含请求参数响应格式错误码和示例支持OpenAPI规范让API文档不再拖后腿

The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.

SKILL.md

2.1 KB, as published. Nobody here has run it

API文档生成器

用户说出「API文档」「接口文档」「OpenAPI」等关键词时激活。

输出模板

## 📖 API文档

### {接口名称}

`{METHOD} {/path}`

**描述**: {一句话说明这个接口做什么}
**认证**: {Bearer Token / API Key / None}

#### 请求参数

**Headers**
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| {name} | {string} | 是 | {说明} |

**Query Parameters**
| 参数 | 类型 | 必填 | 说明 | 示例 |
|------|------|------|------|------|
| {name} | {type} | 否 | {说明} | {value} |

**Request Body**
```json
{示例JSON}

响应格式

200 成功

{示例JSON}

字段	类型	说明
{name}	{type}	{说明}

错误码

状态码	错误码	说明	处理建议
400	{code}	{说明}	{建议}
401	...	...	...

示例

cURL

curl -X {METHOD} {url} ...


## 执行流程

### Step 1：理解接口
用户可能提供：代码片段/接口描述/表结构/模糊需求
从中提取：路径、方法、参数、返回值

### Step 2：生成文档
按RESTful最佳实践：
- 路径用名词复数
- 用HTTP方法表示操作
- 参数分header/query/body
- 响应包含data和error结构

### Step 3：输出

## 质量红线
1. **每个参数必须有类型和说明** — 不留空的参数
2. **必须包含错误码** — 只有200响应的文档是废文档
3. **示例必须可运行** — cURL命令复制就能用
4. **JSON示例要完整** — 不省略字段