api-docs
starsforks
How to install api-docs?
girijashankarj/cursor-handbook/api-docs
$npx -y skills add girijashankarj/cursor-handbook --skill api-docsWorkflow for creating comprehensive API documentation. Use when the user needs to document API endpoints.
SKILL.md
| 1 | # Skill: Create API Documentation |
| 2 | |
| 3 | ## Trigger |
| 4 | When the user needs to document API endpoints. |
| 5 | |
| 6 | ## Prerequisites |
| 7 | - [ ] API endpoints exist or are designed |
| 8 | - [ ] OpenAPI/Swagger tooling available (optional) |
| 9 | - [ ] Access to route definitions or handler files |
| 10 | |
| 11 | ## Steps |
| 12 | |
| 13 | ### Step 1: Inventory Endpoints |
| 14 | - [ ] List all API endpoints |
| 15 | - [ ] Group by resource/entity |
| 16 | - [ ] Note HTTP method and path for each |
| 17 | |
| 18 | ### Step 2: Document Each Endpoint |
| 19 | For each endpoint: |
| 20 | - [ ] HTTP method and URL |
| 21 | - [ ] Description and purpose |
| 22 | - [ ] Authentication requirements |
| 23 | - [ ] Request parameters (path, query, header) |
| 24 | - [ ] Request body schema |
| 25 | - [ ] Response schemas (success + errors) |
| 26 | - [ ] Example request and response |
| 27 | - [ ] Rate limiting details |
| 28 | |
| 29 | ### Step 3: Create OpenAPI Spec |
| 30 | - [ ] Define info, servers, security schemes |
| 31 | - [ ] Create component schemas (reusable) |
| 32 | - [ ] Define paths with all operations |
| 33 | - [ ] Add examples for all schemas |
| 34 | - [ ] Validate spec |
| 35 | |
| 36 | ### Step 4: Generate Documentation |
| 37 | - [ ] Use Swagger UI or Redoc for interactive docs |
| 38 | - [ ] Host at `/api/docs` or similar |
| 39 | - [ ] Include in CI/CD for auto-updates |
| 40 | |
| 41 | ### Step 5: Review |
| 42 | - [ ] All endpoints documented |
| 43 | - [ ] Examples are accurate and working |
| 44 | - [ ] Error responses documented |
| 45 | - [ ] Authentication flow documented |
| 46 | |
| 47 | ## Completion Checklist |
| 48 | - [ ] All endpoints have method, URL, params, body, response |
| 49 | - [ ] Error responses (4xx, 5xx) documented |
| 50 | - [ ] Examples validated against live API or schema |
| 51 | - [ ] OpenAPI spec validates (if used) |
| 52 | |
| 53 | ## If Step Fails |
| 54 | - **Step 1 (inventory)**: Search for route definitions: `**/*.route*.ts`, `**/routes/**`, `app.get|post|put|delete` |
| 55 | - **Step 3 (OpenAPI)**: Use minimal spec first; add complexity incrementally. Validate with `swagger-cli validate` |
| 56 | - **Step 4 (generate)**: Swagger UI needs valid spec; Redoc is more forgiving. Check CORS if hosted separately |
| 57 | |
| 58 | ## Example |
| 59 | Step 2 for `POST /api/v1/orders`: Method POST, URL `/api/v1/orders`, Body `{ customerId, items: [{ productId, quantity }] }`, Response 201 `{ data: { id, status } }`, Errors 400 validation, 404 customer not found. |
People who liked this also viewed
6 picksType
- grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026
- lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026
- lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026
- docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026
- edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026
- lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026
