Review API design — endpoints, types, contracts, error handling, versioning, and consistency. Trigger on /api-design, or when designing or reviewing API specifications.
インストール
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
Review API design — endpoints, types, contracts, error handling, versioning, and consistency. Trigger on /api-design, or when designing or reviewing API specifications.
user-invocable
true
allowed-tools
Read, Grep, Glob, Bash, Edit
API Design
Review API contracts for consistency, completeness, and usability.
Review Checklist
1. Naming and structure
Consistent URL patterns (/resources, /resources/:id, not mixed conventions)?
RESTful resource orientation (nouns, not verbs in URL)?
Consistent pluralization?
Versioning strategy (/v1/, header-based, or no versioning)?
2. Request design
Required vs optional fields clearly defined?
Input validation rules documented?
Content-Type handling consistent?
Pagination strategy for list endpoints? (cursor vs offset)
Filtering/searching parameters consistent?
3. Response design
Consistent response structure (same envelope for success/error)?
Error format consistent (code, message, details)?
HTTP status codes used appropriately? (200, 201, 204, 400, 401, 403, 404, 409, 422, 500)