メニュー
RESTful and GraphQL API design skill with endpoint patterns, request/response schemas, versioning, pagination, filtering, error handling, and API documentation.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
Use when implementing accessible web content following WCAG 2.1 AA standards, semantic HTML, ARIA attributes, keyboard navigation, and screen reader support. Includes accessibility testing, compliance verification, and inclusive design practices. Based on CPACC certification and W3C WCAG standards.
Use when coordinating multiple agents for complex tasks, managing agent teams, or delegating work across specialized agents. Includes patterns for agent communication, task delegation, and team coordination following Qwen Orchestrator conventions. Based on agent collaboration patterns and distributed systems best practices.
Use when managing agile projects, facilitating Scrum ceremonies, conducting backlog grooming, sprint planning, velocity tracking, and implementing Kanban workflows. Includes agile metrics, team dynamics, and agile transformation guidance. Based on CSM, CSP, PRINCE2 certifications.
Use when verifying AI-generated content, validating claims, checking source credibility, implementing evidence-based reasoning, and preventing AI hallucinations. Includes source verification, fact-checking, and validation frameworks. Based on information verification best practices and AI safety guidelines.
Anti-pattern detection and prevention skill. Catches hardcoded data, non-functional UI elements, placeholder code, N+1 queries, and other common development anti-patterns before they ship.
Use when creating API documentation, implementing OpenAPI specifications, writing Swagger documentation, creating GraphQL schemas, and generating SDKs. Includes documentation best practices, API versioning, and API documentation automation. Based on CPTD and OpenAPI Specification certifications.
| name | api-design |
| description | RESTful and GraphQL API design skill with endpoint patterns, request/response schemas, versioning, pagination, filtering, error handling, and API documentation. |
| license | MIT |
This skill provides comprehensive API design guidance following industry best practices.
GET /api/v1/resources # List (paginated, filtered)
GET /api/v1/resources/:id # Detail (with includes)
POST /api/v1/resources # Create
PATCH /api/v1/resources/:id # Partial update
PUT /api/v1/resources/:id # Full replace
DELETE /api/v1/resources/:id # Delete (soft by default)
POST /api/v1/resources/:id/restore # Restore soft-deleted
// Success - Single
{ data: { ... }, meta: { requestId, timestamp } }
// Success - Collection
{
data: [...],
meta: { requestId, timestamp },
pagination: {
page: 1,
perPage: 20,
total: 150,
totalPages: 8,
hasNext: true,
hasPrev: false
}
}
// Error
{
error: {
code: "VALIDATION_ERROR",
message: "Human-readable message",
details: [
{ field: "email", message: "Invalid email format" }
]
},
meta: { requestId, timestamp }
}
GET /api/v1/products?
filter[category]=electronics&
filter[price_min]=10&
filter[price_max]=100&
filter[status]=active&
sort=-createdAt,name&
page=2&
perPage=50&
include=category,variants
| Code | Usage |
|---|---|
| 200 | Success (GET, PATCH, PUT, DELETE) |
| 201 | Created (POST) |
| 204 | No Content (successful DELETE with no body) |
| 400 | Validation Error |
| 401 | Unauthorized (missing/invalid auth) |
| 403 | Forbidden (insufficient permissions) |
| 404 | Not Found |
| 409 | Conflict (duplicate, version mismatch) |
| 422 | Unprocessable Entity (business rule violation) |
| 429 | Too Many Requests (rate limiting) |
| 500 | Internal Server Error |
URL Versioning (recommended for REST):
/api/v1/resources
/api/v2/resources
Header Versioning (alternative):
Accept: application/vnd.api.v1+json
Every resource MUST have these endpoints:
// 1. CREATE - Full validation
POST /api/v1/products
Body: { name, sku, price, categoryId, ... }
Response: 201 { data: product }
// 2. READ LIST - Paginated with filters
GET /api/v1/products?filter[status]=active&sort=-createdAt
Response: 200 { data: [...], pagination: {...} }
// 3. READ DETAIL - With relationships
GET /api/v1/products/:id?include=category,variants
Response: 200 { data: product }
// 4. UPDATE - Partial update
PATCH /api/v1/products/:id
Body: { price: 29.99 }
Response: 200 { data: product }
// 5. DELETE - Soft delete
DELETE /api/v1/products/:id
Response: 200 { data: { deleted: true } }
// 6. RESTORE - If soft delete
POST /api/v1/products/:id/restore
Response: 200 { data: product }
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1620000000
Every endpoint must document:
Do NOT use this skill when: