api-patterns
API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination.
- License 许可
- MIT
- 最近更新
- 2026-04-14
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- api-patterns
- risk
- unknown
- source
- community
- date_added
- 2026-02-27
- description
- API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination.
02 资源文件 11
- 参考文档api-style.md1.1 KB
- 参考文档auth.md576 B
- 参考文档documentation.md549 B
- 参考文档graphql.md977 B
- 参考文档rate-limiting.md726 B
- 参考文档response.md921 B
- 参考文档rest.md1.3 KB
- 脚本scripts/api_validator.py7.4 KB
- 参考文档security-testing.md2.8 KB
- 参考文档trpc.md801 B
- 参考文档versioning.md651 B
03 SKILL.md 正文
API Patterns
API design principles and decision-making for 2025. Learn to THINK, not copy fixed patterns.
? Selective Reading Rule
Read ONLY files relevant to the request! Check the content map, find what you need.
? Content Map
| 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 |
? Related Skills
| Need | Skill |
|---|---|
| API implementation | @[skills/backend-development] |
| Data structure | @[skills/database-design] |
| Security details | @[skills/security-hardening] |
✅ Decision Checklist
Before designing an API:
- [ ] Asked user about API consumers?
- [ ] Chosen API style for THIS context? (REST/GraphQL/tRPC)
- [ ] Defined consistent response format?
- [ ] Planned versioning strategy?
- [ ] Considered authentication needs?
- [ ] Planned rate limiting?
- [ ] Documentation approach defined?
❌ Anti-Patterns
DON'T:
- Default to REST for everything
- Use verbs in REST endpoints (/getUsers)
- Return inconsistent response formats
- Expose internal errors to clients
- Skip rate limiting
DO:
- Choose API style based on context
- Ask about client requirements
- Document thoroughly
- Use appropriate status codes
Script
| Script | Purpose | Command |
|---|---|---|
scripts/api_validator.py |
API endpoint validation | python scripts/api_validator.py <project_path> |
When to Use
This skill is applicable to execute the workflow or actions described in the overview.
04 同仓库更多 Skills
webapp-testing
To test local web applications, write native Python Playwright scripts.
python-packaging
Comprehensive guide to creating, structuring, and distributing Python packages using modern packaging tools, pyproject.toml, and publishing to PyPI.
canvas-design
These are instructions for creating design philosophies - aesthetic movements that are then EXPRESSED VISUALLY. Output only .md files, .pdf files, and .png files.
webapp-testing
To test local web applications, write native Python Playwright scripts.
slack-gif-creator
A toolkit providing utilities and knowledge for creating animated GIFs optimized for Slack.
frontend-design
You are a frontend designer-engineer, not a layout generator.