api-design-patterns

SKILL.md

| GET /v1/users | GET /v1/getUsers | No verbs — HTTP method implies action | | POST /v1/users | POST /v1/user/create | POST to collection = create | | GET /v1/order-items | GET /v1/orderItems | Kebab-case, not camelCase | | GET /v1/users/{id}/orders | GET /v1/users/{id}/orders/{oid}/items | Max 2 nesting levels |

| POST /v1/orders/{id}/actions/cancel | POST /v1/cancelOrder/{id} | Action sub-resource for non-CRUD |

| Method | Purpose | Request Body | Success Status | Idempotent |

Convenciones de diseño de contratos API para proyectos FastAPI con Pydantic v2. Úselo durante la fase de diseño al planificar nuevos puntos finales de API, definir contratos de solicitud/respuesta, diseñar paginación o filtrado, estandarizar respuestas de error o planificar el control de versiones de API. Cubre la denominación RESTful, la semántica del método HTTP, las convenciones de nomenclatura del esquema Pydantic v2 (XxxCreate/XxxUpdate/XxxResponse), la paginación basada en cursor, el formato de error estándar y la documentación de OpenAPI. NO cubre detalles de implementación (use python-backend-expert) o arquitectura a nivel de sistema (use system-architecture). Fuente: hieutrtr/ai1-skills.

Ver original