aac-review-api-design
Review workflow: API Design Review Workflow
- License 许可
- MIT
- 最近更新
- 2026-08-29
- Stars
- ★ 3
- Forks
- 0
01 前言 Front Matter
- name
- aac-review-api-design
- description
- Review workflow: API Design Review Workflow
02 资源文件 7
- 其他customize.toml147 B
- 参考文档generate-trail.md1.9 KB
- 参考文档step-01-orientation.md4.9 KB
- 参考文档step-02-walkthrough.md4.1 KB
- 参考文档step-03-detail-pass.md4.9 KB
- 参考文档step-04-testing.md2.6 KB
- 参考文档step-05-wrapup.md1.2 KB
03 SKILL.md 正文
API Design Review Workflow
You are an API Design Reviewer. Evaluate API endpoints against REST conventions and produce actionable feedback.
Review Checklist
1. Resource Naming
- Plural nouns (
/usersnot/user) - Kebab-case for multi-word resources
- No verbs in URLs
- Sub-resources for relationships
2. HTTP Methods
- GET for retrieval (idempotent, safe)
- POST for creation and actions
- PUT for full replacement (idempotent)
- PATCH for partial update
- DELETE for removal (idempotent)
3. Status Codes
- 200/201/204 for success (not 200 for everything)
- 400/401/403/404/409/422 for client errors
- 429 for rate limiting
- 500/502/503 for server errors
4. Error Responses
- Consistent envelope format
- Machine-readable error codes
- Human-readable messages
- Field-level validation details
5. Pagination
- All collection endpoints paginated
- Consistent pagination format
- Total count included
6. Versioning
- URL path versioning (
/api/v1/) - Breaking changes in new major version only
Output
Produce an API design review report listing violations, recommendations, and compliance score.
04 同仓库更多 Skills
bmad-teach-me-testing
Teach testing progressively through structured sessions. Use when user says "lets learn testing" or "I want to study test practices"
aac-testarch-trace
Generate traceability matrix and quality gate decision. Use when the user says "lets create traceability matrix" or "I want to analyze test coverage"
aac-testarch-test-review
Review test quality using best practices validation. Use when user says "lets review tests" or "I want to evaluate test quality"
aac-testarch-test-design
Create system-level or epic-level test plans. Use when the user says "lets design test plan" or "I want to create test strategy"
aac-testarch-nfr
Audit NFR evidence for performance, security, reliability, and scalability. Use when implementation evidence exists and the user says "audit NFR evidence", "audit NFRs", or "evaluate non-functional requirements"
aac-testarch-framework
Initialize test framework with Playwright or Cypress. Use when the user says "lets setup test framework" or "I want to initialize testing framework"