菜单
Apply REST/HTTP API design conventions when implementing endpoints, handlers, middleware, request validation, or response formatting. Covers resource naming, status codes, error formats, versioning, and pagination.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/irahardianto/claude-superpowers --skill api-design-principles命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
Execute a structured code review protocol that inspects code quality against the full rule set. Use when auditing code written by yourself or another agent, during code audit workflows, or when the user asks for a code review. Produces a findings document with severity tags.
Generates distinctive, production-grade frontend interfaces and artifacts (React, Vue, HTML/CSS). Prioritizes bold aesthetics, unique typography, and motion to avoid generic designs. Use when building websites, landing pages, dashboards, posters, or when the user requests to style, beautify, or create visually striking UI.
Structured research protocol for investigating technologies, patterns, and APIs before implementation. Use when exploring unfamiliar technologies, evaluating library options, or documenting technical findings. Covers multi-tool search strategy, research log conventions, and training data fallback honesty protocol.
基于 SOC 职业分类
正在显示 SKILL.md
| name | api-design-principles |
| description | Apply REST/HTTP API design conventions when implementing endpoints, handlers, middleware, request validation, or response formatting. Covers resource naming, status codes, error formats, versioning, and pagination. |
| user-invocable | false |
Resource-Based URLs:
/api/{version}/users, /api/{version}/orders/api/{version}/users/:userId/orders/api/{version}/getUser ❌ → /api/{version}/users/:id ✅HTTP Methods:
Versioning:
/api/{version}/users e.g./api/v1/users (explicit, clear)Pagination:
?cursor=abc123 (better for real-time data)?page=2&limit=20 (simpler, less accurate for changing data)Filtering and Sorting:
?status=active&role=admin?sort=created_at:desc,name:asc?q=search+termSuccess Codes:
Client Error Codes (4xx) - User Can Fix:
Validation Errors (400 Bad Request):
Authentication Errors (401 Unauthorized):
Authorization Errors (403 Forbidden):
Not Found Errors (404 Not Found):
Business Rule Violations (409 Conflict / 422 Unprocessable Entity):
Rate Limiting (429 Too Many Requests):
Server Error Codes (5xx) - System Issue:
Infrastructure Errors (500/502/503):
{
"data": { /* resource or array of resources */ },
"meta": {
"total": 100,
"page": 1,
"perPage": 20
},
"links": {
"self": "/api/v1/users?page=1",
"next": "/api/v1/users?page=2",
"prev": null
}
}
All API errors must follow a consistent envelope structure, matching the success format where possible or using a standard error envelope.
{
"status": "error", // Transport: Always "error" or "fail"
"code": 400, // Transport: Redundant HTTP Status
"error": { // Domain: The actual business problem
"code": "VALIDATION_ERROR", // Machine-readable business code (UPPER_SNAKE)
"message": "Invalid email format", // Human-readable message
"details": { // Optional: Structured context
"field": "email",
"reason": "Must be a valid address"
},
"correlationId": "req-1234567890", // Ops: Traceability
"doc_url": "https://..." // Optional: Help link
}
}