菜单
API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | api-patterns |
| description | API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination. |
| allowed-tools | Read, Write, Edit, Glob, Grep |
API design principles and decision-making for 2025. Learn to THINK, not copy fixed patterns.
Read ONLY files relevant to the request! Check the content map, find what you need.
| File | Description | When to Read |
|---|---|---|
api-style.md | REST vs GraphQL vs tRPC decision tree | Choosing API type |
rest.md | Resource naming, HTTP methods, status codes | Designing REST API |
response.md | Envelope pattern, error format, pagination | Response structure |
graphql.md | Schema design, when to use, security | Considering GraphQL |
trpc.md | TypeScript monorepo, type safety | TS fullstack projects |
versioning.md | URI/Header/Query versioning | API evolution planning |
auth.md | JWT, OAuth, Passkey, API Keys | Auth pattern selection |
rate-limiting.md | Token bucket, sliding window | API protection |
documentation.md | OpenAPI/Swagger best practices | Documentation |
security-testing.md | OWASP API Top 10, auth/authz testing | Security audits |
| Need | Skill |
|---|---|
| API implementation | @[skills/backend-development] |
| Data structure | @[skills/database-design] |
| Security details | @[skills/security-hardening] |
Before designing an API:
DON'T:
DO:
| Script | Purpose | Command |
|---|---|---|
scripts/api_validator.py | API endpoint validation | python scripts/api_validator.py <project_path> |
Gather relevant source files for a task, resolve their dependencies, and package everything into a structured context prompt.
Produce an architectural design and implementation plan based on task requirements, identifying scope, dependencies, impact, and a step-by-step rollout strategy.
Explore the codebase and export a structured context file (e.g., context.xml) for pasting into an external LLM like ChatGPT or Claude Web.
Trace execution paths from an error or bug report to find the root cause, gathering surrounding context (callers, imports, tests) along the way.
Analyze dependencies, callers, and coupling before refactoring, then produce a safe incremental refactoring plan.
Review recent code changes by gathering git diffs, identifying affected callers and tests, and analyzing for security, performance, and breaking changes.
