- name
SKILL.md
Le fichier du skill reste dans le dépôt de l'éditeur.
Collez la commande copiée dans un terminal. Elle installe ce SKILL.md dans cet agent.
npx skills add JackyST0/awesome-agent-skills --skill api-doc-generator -a cursor -yCollez la commande copiée dans un terminal. Elle installe ce SKILL.md dans cet agent.
npx skills add JackyST0/awesome-agent-skills --skill api-doc-generator -a claude-code -yCollez la commande copiée dans un terminal. Elle installe ce SKILL.md dans cet agent.
npx skills add JackyST0/awesome-agent-skills --skill api-doc-generator -a codex -yCollez la commande copiée dans un terminal. Elle installe ce SKILL.md dans cet agent.
npx skills add JackyST0/awesome-agent-skills --skill api-doc-generator -a grok -yEnvoyez le message copié dans un chat Grok Bot. Le Bot récupère ce SKILL.md sur GitHub et l'ajoute aux skills que partagent tous vos Bots.
Install this skill: https://github.com/JackyST0/awesome-agent-skills/tree/HEAD/examples/api-doc-generatorDe l'éditeur
根据代码生成 API 文档,支持 REST API、GraphQL 及多种文档格式。
Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.
当用户请求以下操作时使用此 skill:
每个 API 端点应包含:
支持以下文档格式:
templates/api-doc.md 模板Use templates/api-doc.md for Markdown output format.
## API 文档 / API Documentation
### 端点概览 / Endpoint Overview
| 方法 | 路径 | 描述 |
|------|------|------|
| GET | /api/resource | 获取资源列表 |
### 详细说明 / Details
#### [方法] /path
**描述**: ...
**请求参数**:
| 参数 | 类型 | 必需 | 描述 |
|------|------|------|------|
**请求示例**:
```json
{}
```
**响应示例**:
```json
{}
```
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
app = FastAPI()
class User(BaseModel):
id: int
name: str
email: str
@app.get("/users/{user_id}")
async def get_user(user_id: int) -> User:
"""Get a user by ID."""
if user_id <= 0:
raise HTTPException(status_code=404, detail="User not found")
return User(id=user_id, name="John", email="[email protected]")
@app.post("/users")
async def create_user(user: User) -> User:
"""Create a new user."""
return user
描述: 根据用户 ID 获取用户信息
路径参数:
响应 200 - 成功:
{
"id": 1,
"name": "John",
"email": "[email protected]"
}
响应 404 - 未找到:
{
"detail": "User not found"
}
描述: 创建新用户
请求体:
请求示例:
{
"id": 1,
"name": "John",
"email": "[email protected]"
}
响应 200 - 成功:
{
"id": 1,
"name": "John",
"email": "[email protected]"
}
Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.
---name: api-doc-generatordescription: Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.---# examples/api-doc-generator/SKILL.mdFAQ
Téléchargez examples/api-doc-generator/SKILL.md auprès de l'éditeur, ou copiez le chemin et ouvrez le dépôt. PlugMCP répertorie le skill et n'héberge pas le fichier.
L'éditeur le maintient sur https://github.com/JackyST0/awesome-agent-skills.
Claude, Cursor, Codex et Grok Build peuvent lire un SKILL.md que vous ajoutez depuis le dépôt de l'éditeur. Grok Bot l'installe lorsque vous envoyez dans un chat le lien du dossier GitHub du skill.