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 |

Conventions de conception de contrats API pour les projets FastAPI avec Pydantic v2. À utiliser pendant la phase de conception lors de la planification de nouveaux points de terminaison d'API, de la définition de contrats de demande/réponse, de la conception de la pagination ou du filtrage, de la standardisation des réponses aux erreurs ou de la planification du versionnage de l'API. Couvre la dénomination RESTful, la sémantique des méthodes HTTP, les conventions de dénomination des schémas Pydantic v2 (XxxCreate/XxxUpdate/XxxResponse), la pagination basée sur le curseur, le format d'erreur standard et la documentation OpenAPI. Ne couvre PAS les détails d'implémentation (utilisez python-backend-expert) ou l'architecture au niveau du système (utilisez l'architecture système). Source : hieutrtr/ai1-skills.

Voir l'original