メニュー
Use when designing REST API endpoints, URL structure, HTTP methods, status codes, request/response formats, pagination, SSE streaming, or OpenAPI docs in Axum.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
Use when creating modules, organizing project structure, designing layered architecture (handler/service/domain/repo), dependency injection, or DDD patterns in Rust.
Use when designing PostgreSQL schemas, writing SQLx migrations, choosing data types, naming tables/columns/indexes, or writing compile-time checked queries.
Use when implementing error types, designing error hierarchies, mapping errors to HTTP responses, or reviewing error handling patterns in Rust code using thiserror and anyhow.
Use when setting up tracing, configuring log levels, writing structured logs, using spans and instrument, or handling sensitive data in Rust logs.
Use when writing unit/integration tests, setting up test infrastructure, mocking with wiremock/mockall, or designing test structure in Rust.
| name | rust-api-design |
| description | Use when designing REST API endpoints, URL structure, HTTP methods, status codes, request/response formats, pagination, SSE streaming, or OpenAPI docs in Axum. |
Use URL path versioning as the default strategy:
/v1/orders
/v1/products/{id}
/v1//v2/, keep /v1/ available for a documented deprecation periodGET /v1/orders
POST /v1/orders
GET /v1/orders/{id}
PATCH /v1/orders/{id}
DELETE /v1/orders/{id}
Rules:
orders not orderapi-keys not apiKeys/v1/users/{id}/ordersUse only when the operation cannot be mapped to a standard resource operation:
POST /v1/auth/login
POST /v1/orders/{id}/cancel
POST /v1/payments/{id}/refund
| Method | Idempotent | Usage |
|---|---|---|
| GET | Yes | Retrieve a resource |
| POST | No | Create a resource / execute an action |
| PATCH | Depends | Partial update (idempotent if setting absolute values; not idempotent if using relative operations like increment) |
| DELETE | Yes | Delete a resource |
POST idempotency: Use Idempotency-Key header for operations that must not be duplicated (e.g., payment processing).
Field names: snake_case
Enum values: snake_case
{
"order_type": "bulk_purchase",
"status": "in_progress"
}
{
"data": [...],
"pagination": {
"total": 100,
"limit": 20,
"offset": 0,
"has_more": true
}
}
{
"error": {
"code": "INSUFFICIENT_BALANCE",
"message": "Account balance is too low to complete this purchase"
}
}
| Code | Usage |
|---|---|
| 200 | GET/PATCH success |
| 201 | POST created successfully |
| 204 | DELETE success (no body) |
| 400 | Malformed request |
| 401 | Unauthenticated |
| 403 | Forbidden (authenticated but not authorized) |
| 404 | Resource not found |
| 422 | Business rule validation failure |
| 429 | Rate limited |
| 500 | Internal server error |
Authorization: Bearer <token>
All authenticated endpoints must validate the Bearer token. Return 401 for missing/invalid tokens and 403 for valid tokens with insufficient permissions.
GET /v1/orders/{id}/events
Accept: text/event-stream
event: progress
data: {"progress": 50}
event: complete
data: {"status": "completed"}
event type and JSON data payload: ping) at regular intervals to prevent connection timeoutsUse utoipa crate for annotation-driven API documentation. Expose the generated spec at a well-known endpoint (e.g., GET /docs/openapi.json). Keep annotations co-located with handler functions.
/v1/)snake_case for both field names and enum valuescode + message