跳到正文
cccskills
免费在 GitHub 公开

doc-generator

Create or update API documentation from source code. The skill produces OpenAPI/Swagger specifications, descriptions of API operations, parameter and response references, authentication guidance, and practical examples for developers integrating an API.

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

原文查看原文说明

Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users mention API docs, endpoints, or documentation.

查看安装方法

适用场景

  • Creating API documentation from source code
  • Generating OpenAPI/Swagger specifications
  • Preparing API request and response examples
  • Writing authentication and error references

包含的文件(2)

  • SKILL.md1.7 KB
  • generate-docs.py1.6 KB

SKILL.md(原文)

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

API Documentation Generator Skill

Generates

  • OpenAPI/Swagger specifications
  • API endpoint documentation
  • SDK usage examples
  • Integration guides
  • Error code references
  • Authentication guides

Documentation Structure

For Each Endpoint

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

### Description
Brief explanation of what this endpoint does

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |

### Response

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

**404 Not Found**
```json
{
  "error": "USER_NOT_FOUND",
  "message": "User does not exist"
}
```

### Examples

**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()
```

Last Updated: August 4, 2026 Claude Code Version: 2.1.220 Sources:

评价

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

评论

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

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

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

0 / 1000 字

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

同一仓库的技能

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.2万2026年10月16日 更新

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.2万2026年10月16日 更新

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.2万2026年10月16日 更新

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.2万2026年10月16日 更新

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.2万2026年10月16日 更新

Create marketing copy, customer messages, and public content with a consistent brand voice. Apply clear vocabulary, concise sentences, concrete examples, and a friendly, professional tone so readers can understand the value being offered.

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

  • Aligning marketing copy with a consistent brand voice
  • Keeping customer messages friendly and professional
  • Simplifying technical explanations for general readers
luongnv89/claude-howto4.2万2026年10月16日 更新

查看 luongnv89 的全部技能

报告此技能的问题