跳到正文
cccskills
免费在 GitHub 公开

doc-generator

Create or update API documentation from source code. Produce OpenAPI or Swagger specifications, endpoint descriptions, parameter tables, response examples, authentication guides, error references, and usage examples that explain how to call the API.

中文简介正在准备中。当前显示英语简介。

原文查看原文说明

从源代码生成全面且准确的 API 文档。适用于创建或更新 API 文档、生成 OpenAPI 规范,或在用户提到 API 文档、端点或说明时使用。

查看安装方法

适用场景

  • Create API documentation from source code
  • Generate an OpenAPI or Swagger specification
  • Document parameters, responses, and errors
  • Prepare SDK examples and integration guides

包含的文件(1)

  • SKILL.md1.3 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

API 文档生成 Skill

可生成内容

  • OpenAPI / Swagger 规范
  • API 端点文档
  • SDK 使用示例
  • 集成指南
  • 错误码参考
  • 认证指南

文档结构

每个端点的写法

## GET /api/v1/users/:id

### 描述
简要说明这个端点做什么

### 参数

| 名称 | 类型 | 必填 | 说明 |
|------|------|------|------|
| id | string | 是 | 用户 ID |

### 响应

**200 成功**
```json
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2025-01-15T10:30:00Z"
}
```

**404 未找到**
```json
{
  "error": "USER_NOT_FOUND",
  "message": "User does not exist"
}
```

### 示例

**cURL**
```bash
curl -X GET "https://api.example.com/api/v1/users/usr_123" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

**JavaScript**
```javascript
const user = await fetch('/api/v1/users/usr_123', {
  headers: { 'Authorization': 'Bearer token' }
}).then(r => r.json());
```

**Python**
```python
response = requests.get(
    'https://api.example.com/api/v1/users/usr_123',
    headers={'Authorization': 'Bearer token'}
)
user = response.json()
```

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Turn ideas and reference materials into a blog draft through research, outline approval, and revision. The workflow includes source citations, adjustments for the intended audience and tone, and separate files for each draft version.

中文简介正在准备中。当前显示英语简介。

  • Turning research materials into a blog post
  • Planning an article for a specific audience
  • Drafting articles with source citations
luongnv89/claude-howto4.3万2026年10月20日 更新

Turn ideas and reference materials into a blog draft through research, discussion, and an approved outline. Produce cited articles tailored to the intended audience, then revise them while keeping each draft version.

中文简介正在准备中。当前显示英语简介。

  • Turning an idea into a blog draft
  • Writing an article from research materials
  • Agreeing on an outline before drafting
luongnv89/claude-howto4.3万2026年10月20日 更新

Turn ideas and reference materials into a blog draft with source citations. Work through research, topic development, an approved outline, and revisions, while saving source summaries and numbered drafts to track how the article develops.

中文简介正在准备中。当前显示英语简介。

  • Turning an idea into a structured blog draft
  • Writing an article from research and reference materials
  • Revising an existing draft while keeping earlier versions
luongnv89/claude-howto4.3万2026年10月20日 更新

Turn ideas and reference materials into a blog draft through research, outline approval, and revision. The workflow includes source citations, adjustments for the intended audience and tone, and separate files for each draft version.

中文简介正在准备中。当前显示英语简介。

  • Turning research materials into a blog post
  • Planning an article for a specific audience
  • Drafting articles with source citations
luongnv89/claude-howto4.3万2026年10月20日 更新

Write marketing copy, customer messages, and public content in a consistent brand voice. Apply predefined guidance on tone, sentence length, preferred terms, and concrete examples to keep communication friendly, professional, clear, and concise.

中文简介正在准备中。当前显示英语简介。

  • Write marketing copy in a consistent tone
  • Align customer messages with brand guidance
  • Simplify technical explanations for readers
luongnv89/claude-howto4.3万2026年10月20日 更新

Keep marketing copy, customer messages, and public content consistent with a defined brand voice. The skill provides rules for a friendly, professional tone, concise sentences, concrete examples, preferred terminology, and clear calls to action.

中文简介正在准备中。当前显示英语简介。

  • Keeping marketing copy consistent in tone
  • Writing customer messages in the brand's voice
  • Aligning terminology across public content
luongnv89/claude-howto4.3万2026年10月20日 更新

查看 luongnv89 的全部技能

报告此技能的问题