api-design
starsforks
How to install api-design?
omnigentx/jarvis/api-design
$npx -y skills add omnigentx/jarvis --skill api-designDesign API contracts and schemas. Use when a BA needs to define interfaces between frontend and backend, or between services.
SKILL.md
| 1 | # API DESIGN |
| 2 | |
| 3 | ## Workflow |
| 4 | |
| 5 | 1. **Identify use cases** from the BRD. |
| 6 | 2. **Pick a pattern**: REST / WebSocket / gRPC. |
| 7 | 3. **Define endpoints**. |
| 8 | 4. **Write schemas** (request/response types). |
| 9 | 5. **Document** error codes and edge cases. |
| 10 | |
| 11 | ## REST API template |
| 12 | |
| 13 | ```markdown |
| 14 | ### [METHOD] /api/v1/resource |
| 15 | |
| 16 | **Description**: what it does |
| 17 | |
| 18 | **Request**: |
| 19 | - Headers: `Authorization: Bearer <token>` |
| 20 | - Body: |
| 21 | ```json |
| 22 | { "field": "type", "description": "..." } |
| 23 | ``` |
| 24 | |
| 25 | **Response 200**: |
| 26 | ```json |
| 27 | { "data": {...}, "message": "success" } |
| 28 | ``` |
| 29 | |
| 30 | **Error codes**: |
| 31 | | Code | Meaning | |
| 32 | |------|---------| |
| 33 | | 400 | Invalid request | |
| 34 | | 401 | Unauthorized | |
| 35 | | 404 | Not found | |
| 36 | ``` |
| 37 | |
| 38 | ## Rules |
| 39 | - Endpoint paths use plural nouns (`/users`, not `/user`). |
| 40 | - Versioning lives in the URL (`/api/v1/`). |
| 41 | - Always use a single, consistent error-response shape. |
| 42 | - Paginate list endpoints (`?page=1&limit=20`). |
People who liked this also viewed
6 picksType
- web-design-guidelinesReview UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my site against best practices".SkillsJul 2026
- lark-slides飞书幻灯片：创建和编辑幻灯片。创建演示文稿、读取幻灯片内容、管理幻灯片页面（创建、删除、读取、局部替换）。当用户需要创建或编辑幻灯片、读取或修改单个页面时使用。当用户给出 doubao.com 的 /slides/ URL/token 时，也应直接使用本 skill，不要因为域名不是飞书而回退到 WebFetch；路由依据是 URL 路径模式和 token，而不是域名。不负责：云文档内容编辑（走 SkillsJul 2026
- design-taste-frontendTaste-Skill - gives your AI good taste. stops the AI from generating boring, generic slop SkillsJul 2026
- ui-ux-pro-maxUI/UX design intelligence for web and mobile. Searchable local database with 84 styles, 192 color palettes, 74 font pairings, 192 product types, 98 UX guidelines, 104 icon entries, 16 GSAP motion presSkillsJul 2026
- caveman-helpQuick-reference card for all caveman modes, skills, and commands. One-shot display, not a persistent mode. Trigger: /caveman-help, "caveman help", "what caveman commands", "how do I use caveman".SkillsJul 2026
- codebase-designShared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find deepening opportunities, decide where a seam goes, make code more testable or AI-nSkillsJul 2026
