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 |

Pydantic v2 を使用した FastAPI プロジェクトの API コントラクト設計規則。新しい API エンドポイントの計画、リクエスト/レスポンス コントラクトの定義、ページネーションやフィルタリングの設計、エラー応答の標準化、API のバージョン管理の計画などの設計フェーズ中に使用します。 RESTful 命名、HTTP メソッド セマンティクス、Pydantic v2 スキーマ命名規則 (XxxCreate/XxxUpdate/XxxResponse)、カーソル ベースのページネーション、標準エラー形式、OpenAPI ドキュメントについて説明します。実装の詳細 (python-backend-expert を使用) やシステムレベルのアーキテクチャ (system-architecture を使用) については説明しません。 ソース: hieutrtr/ai1-skills。

原文を見る