Menu
[UDS] 引導 API 設計，遵循 REST、GraphQL 和 gRPC 最佳實踐
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
A direct command skips the review prompt. Inspect the source before running it.
npx skills add https://github.com/AsiaOstrich/universal-dev-standards --skill api-design-assistantThe command stays on one line. Scroll horizontally to inspect it before copying.
Prefer a local copy? Download the files currently available to SkillsMP.
Showing SKILL.md
[UDS] 以 Claude 原生 Agent tool 编排多任务执行计划（DAG-based，无外部引擎）。 Use when: executing a plan.json file with parallel/sequential task dependencies. Keywords: orchestrate, plan, execute, DAG, task plan, 编排, 执行计划, 并行.
[UDS] 从 Spec 文档、OpenSpec 变更或自由文本需求生成 plan.json。 Use when: converting specifications into executable task plans for /orchestrate. Keywords: plan, spec, task plan, 计划, 规格, 任务, plan.json, DAG.
[UDS] AI 辅助 git push 安全层：质量门禁 + 协作护栏。 Use when: pushing commits, force pushing, pushing to protected branches, pushing feature branches. Keywords: git push, force push, protected branch, quality gate, push receipt, PR automation, 推送, 保护分支, 质量门禁.
Based on SOC occupation classification
| name | api-design-assistant |
| source | ../../../../skills/api-design-assistant/SKILL.md |
| source_version | 1.0.0 |
| translation_version | 1.0.0 |
| last_synced | "2026-03-23T00:00:00.000Z" |
| status | current |
| description | [UDS] 引導 API 設計，遵循 REST、GraphQL 和 gRPC 最佳實踐 |
語言: English | 繁體中文
引導 API 設計，遵循 REST、GraphQL 和 gRPC 最佳實踐。
| 方法 | 用途 | 冪等性 |
|---|---|---|
| GET | 讀取資源 | 是 |
| POST | 建立資源 | 否 |
| PUT | 替換資源 | 是 |
| PATCH | 部分更新 | 否 |
| DELETE | 刪除資源 | 是 |
| 代碼 | 說明 |
|---|---|
| 200 | 成功 |
| 201 | 已建立 |
| 204 | 無內容（刪除成功） |
| 400 | 請求格式錯誤 |
| 401 | 未認證 |
| 403 | 無權限 |
| 404 | 資源不存在 |
| 409 | 資源衝突 |
| 422 | 驗證失敗 |
| 429 | 請求過多（限流） |
| 500 | 伺服器內部錯誤 |
| 模式 | 範例 | 說明 |
|---|---|---|
| 集合 | /users | 資源集合 |
| 單一資源 | /users/{id} | 單一資源 |
| 子資源 | /users/{id}/orders | 子資源 |
| 動作 | /users/{id}/activate | 動作（僅限 POST） |
DEFINE ──► DESIGN ──► VALIDATE ──► DOCUMENT
釐清使用者、使用情境、資料模型和非功能性需求。
套用 RESTful 慣例、定義請求/回應 Schema、規劃版本策略。
檢查命名一致性、錯誤格式統一、分頁模式。
產出 OpenAPI/Swagger 規格或 GraphQL Schema 文件。
| 策略 | 範例 | 優點 |
|---|---|---|
| URL 路徑 | /v1/users | 簡單、明確 |
| Header | Accept: application/vnd.api+json;v=1 | URL 乾淨 |
| Query | /users?version=1 | 容易測試 |
/api-design - 互動式 API 設計引導/api-design /users - 審查特定端點設計/api-design --graphql - GraphQL Schema 設計引導/api-design 完成後，AI 助手應建議：
API 設計完成。建議下一步：
- 執行
/sdd建立正式規格文件- 執行
/testing規劃 API 測試策略- 執行
/docs產生 API 文件- 審查安全性 → 執行
/security