api-design-patterns

| 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 |

Соглашения по проектированию контрактов API для проектов FastAPI с Pydantic v2. Используйте на этапе проектирования при планировании новых конечных точек API, определении контрактов запросов/ответов, разработке разбиения на страницы или фильтрации, стандартизации ответов об ошибках или планировании управления версиями API. Охватывает именование RESTful, семантику методов HTTP, соглашения об именах схем Pydantic v2 (XxxCreate/XxxUpdate/XxxResponse), нумерацию страниц на основе курсора, стандартный формат ошибок и документацию OpenAPI. НЕ охватывает детали реализации (используйте python-backend-expert) или архитектуру системного уровня (используйте системную архитектуру). Источник: hieutrtr/ai1-skills.