API 設計パターン

API設計パターン

一貫性があり、開発者にとって使いやすいREST APIを設計するための規約とベストプラクティス。

アクティブにするタイミング

• 新しいAPIエンドポイントの設計
• 既存のAPI契約のレビュー
• ページネーション、フィルタリング、ソートの追加
• APIのエラーハンドリングの実装
• APIバージョニング戦略の計画
• 公開APIまたはパートナー向けAPIの構築

リソース設計

URL構造

# リソースは名詞、複数形、小文字、ケバブケース
GET    /api/v1/users
GET    /api/v1/users/:id
POST   /api/v1/users
PUT    /api/v1/users/:id
PATCH  /api/v1/users/:id
DELETE /api/v1/users/:id

# 関係を表すサブリソース
GET    /api/v1/users/:id/orders
POST   /api/v1/users/:id/orders

# CRUDにマッピングされないアクション（動詞は控えめに）
POST   /api/v1/orders/:id/cancel
POST   /api/v1/auth/login
POST   /api/v1/auth/refresh

命名規則

# GOOD
/api/v1/team-members          # 複数単語リソースはケバブケース
/api/v1/orders?status=active  # フィルタリングにはクエリパラメータ
/api/v1/users/123/orders      # 所有関係にはネストしたリソース

# BAD
/api/v1/getUsers              # URL内の動詞
/api/v1/user                  # 単数形（複数形を使用）
/api/v1/team_members          # URL内のスネークケース
/api/v1/users/123/getOrders   # ネストしたリソース内の動詞

HTTPメソッドとステータスコード

メソッドのセマンティクス

メソッド	冪等性	安全	用途
GET	はい	はい	リソースの取得
POST	いいえ	いいえ	リソース作成、アクションのトリガー
PUT	はい	いいえ	リソースの完全な置き換え
PATCH	いいえ*	いいえ	リソースの部分的な更新
DELETE	はい	いいえ	リソースの削除

*PATCHは適切に実装することで冪等にできます

ステータスコードリファレンス

# 成功
200 OK                    — GET、PUT、PATCH（レスポンスボディあり）
201 Created               — POST（Locationヘッダーを含める）
204 No Content            — DELETE、PUT（レスポンスボディなし）

# クライアントエラー
400 Bad Request           — バリデーション失敗、不正なJSON
401 Unauthorized          — 認証情報がない、または無効
403 Forbidden             — 認証はされているが権限がない
404 Not Found             — リソースが存在しない
409 Conflict              — 重複エントリ、状態の競合
422 Unprocessable Entity  — 意味的に無効（JSONは有効だがデータが不正）
429 Too Many Requests     — レート制限超過

# サーバーエラー
500 Internal Server Error — 予期しない障害（詳細は絶対に公開しない）
502 Bad Gateway           — アップストリームサービスの障害
503 Service Unavailable   — 一時的な過負荷、Retry-Afterヘッダーを含める

よくある間違い

# BAD: すべてに200
{ "status": 200, "success": false, "error": "Not found" }

# GOOD: HTTPステータスコードをセマンティクスに従って使用
HTTP/1.1 404 Not Found
{ "error": { "code": "not_found", "message": "User not found" } }

# BAD: バリデーションエラーに500
# GOOD: 400または422を使用し、フィールドレベルの詳細情報を含める

# BAD: 作成されたリソースに200
# GOOD: 201とLocationヘッダーを使用
HTTP/1.1 201 Created
Location: /api/v1/users/abc-123

レスポンスフォーマット

成功レスポンス

{
  "data": {
    "id": "abc-123",
    "email": "[email protected]",
    "name": "Alice",
    "created_at": "2025-01-15T10:30:00Z"
  }
}

コレクションレスポンス（ページネーション付き）

{
  "data": [
    { "id": "abc-123", "name": "Alice" },
    { "id": "def-456", "name": "Bob" }
  ],
  "meta": {
    "total": 142,
    "page": 1,
    "per_page": 20,
    "total_pages": 8
  },
  "links": {
    "self": "/api/v1/users?page=1&per_page=20",
    "next": "/api/v1/users?page=2&per_page=20",
    "last": "/api/v1/users?page=8&per_page=20"
  }
}

エラーレスポンス

{
  "error": {
    "code": "validation_error",
    "message": "Request validation failed",
    "details": [
      {
        "field": "email",
        "message": "Must be a valid email address",
        "code": "invalid_format"
      },
      {
        "field": "age",
        "message": "Must be between 0 and 150",
        "code": "out_of_range"
      }
    ]
  }
}

レスポンスエンベロープのバリエーション

// オプションA: dataラッパー付きエンベロープ（公開APIに推奨）
interface ApiResponse<T> {
  data: T;
  meta?: PaginationMeta;
  links?: PaginationLinks;
}

interface ApiError {
  error: {
    code: string;
    message: string;
    details?: FieldError[];
  };
}

// オプションB: フラットなレスポンス（よりシンプルで内部APIに一般的）
// 成功: リソースを直接返す
// エラー: エラーオブジェクトを返す
// HTTPステータスコードで判別

ページネーション

オフセットベース（シンプル）

GET /api/v1/users?page=2&per_page=20

# 実装
SELECT * FROM users
ORDER BY created_at DESC
LIMIT 20 OFFSET 20;

長所: 実装が簡単、「Nページへジャンプ」をサポート 短所: 大きなオフセットでは遅い（OFFSET 100000）、同時挿入時に一貫性がない

カーソルベース（スケーラブル）

GET /api/v1/users?cursor=eyJpZCI6MTIzfQ&limit=20

# 実装
SELECT * FROM users
WHERE id > :cursor_id
ORDER BY id ASC
LIMIT 21;   -- has_nextを判定するために1つ多く取得

{
  "data": [...],
  "meta": {
    "has_next": true,
    "next_cursor": "eyJpZCI6MTQzfQ"
  }
}

長所: 位置に関係なくパフォーマンスが安定、同時挿入時に一貫性がある 短所: 任意のページにジャンプできない、カーソルは不透明

どちらを使うべきか

ユースケース	ページネーションタイプ
管理ダッシュボード、小規模データセット（1万件未満）	オフセット
無限スクロール、フィード、大規模データセット	カーソル
公開API	カーソル（デフォルト）、オフセット（オプション）
検索結果	オフセット（ユーザーはページ番号を期待）

フィルタリング、ソート、検索

フィルタリング

# 単純な等価比較
GET /api/v1/orders?status=active&customer_id=abc-123

# 比較演算子（ブラケット記法を使用）
GET /api/v1/products?price[gte]=10&price[lte]=100
GET /api/v1/orders?created_at[after]=2025-01-01

# 複数の値（カンマ区切り）
GET /api/v1/products?category=electronics,clothing

# ネストされたフィールド（ドット記法）
GET /api/v1/orders?customer.country=US

ソート

# 単一フィールド（降順は接頭辞 -）
GET /api/v1/products?sort=-created_at

# 複数フィールド（カンマ区切り）
GET /api/v1/products?sort=-featured,price,-created_at

全文検索

# 検索クエリパラメータ
GET /api/v1/products?q=wireless+headphones

# フィールド指定検索
GET /api/v1/users?email=alice

スパースフィールドセット

# 指定したフィールドのみを返す（ペイロードを削減）
GET /api/v1/users?fields=id,name,email
GET /api/v1/orders?fields=id,total,status&include=customer.name

認証と認可

トークンベース認証

# AuthorizationヘッダーのBearerトークン
GET /api/v1/users
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

# APIキー（サーバー間通信用）
GET /api/v1/data
X-API-Key: sk_live_abc123

認可パターン

// リソースレベル: 所有権の確認
app.get("/api/v1/orders/:id", async (req, res) => {
  const order = await Order.findById(req.params.id);
  if (!order) return res.status(404).json({ error: { code: "not_found" } });
  if (order.userId !== req.user.id) return res.status(403).json({ error: { code: "forbidden" } });
  return res.json({ data: order });
});

// ロールベース: 権限の確認
app.delete("/api/v1/users/:id", requireRole("admin"), async (req, res) => {
  await User.delete(req.params.id);
  return res.status(204).send();
});

レート制限

ヘッダー

HTTP/1.1 200 OK
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

# 超過時
HTTP/1.1 429 Too Many Requests
Retry-After: 60
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 60 seconds."
  }
}

レート制限ティア

ティア	制限	ウィンドウ	ユースケース
匿名	30/min	IP単位	公開エンドポイント
認証済み	100/min	ユーザー単位	標準APIアクセス
プレミアム	1000/min	APIキー単位	有料APIプラン
内部	10000/min	サービス単位	サービス間通信

バージョニング

URLパスバージョニング（推奨）

/api/v1/users
/api/v2/users

長所: 明示的、ルーティングが簡単、キャッシュ可能 短所: バージョン間でURLが変わる

ヘッダーバージョニング

GET /api/users
Accept: application/vnd.myapp.v2+json

長所: クリーンなURL 短所: テストが難しい、忘れやすい

バージョニング戦略

1. /api/v1/から始める — 必要になるまでバージョニングしない
2. 最大2つのアクティブバージョンを維持（現在 + 前）
3. 非推奨のタイムライン:
   - 非推奨を発表（公開APIの場合は6ヶ月前通知）
   - Sunsetヘッダーを追加: Sunset: Sat, 01 Jan 2026 00:00:00 GMT
   - サンセット日以降は410 Goneを返す
4. 非破壊的変更は新しいバージョンを必要としない:
   - レスポンスへの新しいフィールドの追加
   - 新しいオプションクエリパラメータの追加
   - 新しいエンドポイントの追加
5. 破壊的変更には新しいバージョンが必要:
   - フィールドの削除または名前変更
   - フィールドタイプの変更
   - URL構造の変更
   - 認証方法の変更

実装パターン

TypeScript（Next.js APIルート）

import { z } from "zod";
import { NextRequest, NextResponse } from "next/server";

const createUserSchema = z.object({
  email: z.string().email(),
  name: z.string().min(1).max(100),
});

export async function POST(req: NextRequest) {
  const body = await req.json();
  const parsed = createUserSchema.safeParse(body);

  if (!parsed.success) {
    return NextResponse.json({
      error: {
        code: "validation_error",
        message: "Request validation failed",
        details: parsed.error.issues.map(i => ({
          field: i.path.join("."),
          message: i.message,
          code: i.code,
        })),
      },
    }, { status: 422 });
  }

  const user = await createUser(parsed.data);

  return NextResponse.json(
    { data: user },
    {
      status: 201,
      headers: { Location: `/api/v1/users/${user.id}` },
    },
  );
}

Python（Django REST Framework）

from rest_framework import serializers, viewsets, status
from rest_framework.response import Response

class CreateUserSerializer(serializers.Serializer):
    email = serializers.EmailField()
    name = serializers.CharField(max_length=100)

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ["id", "email", "name", "created_at"]

class UserViewSet(viewsets.ModelViewSet):
    serializer_class = UserSerializer
    permission_classes = [IsAuthenticated]

    def get_serializer_class(self):
        if self.action == "create":
            return CreateUserSerializer
        return UserSerializer

    def create(self, request):
        serializer = CreateUserSerializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        user = UserService.create(**serializer.validated_data)
        return Response(
            {"data": UserSerializer(user).data},
            status=status.HTTP_201_CREATED,
            headers={"Location": f"/api/v1/users/{user.id}"},
        )

Go（net/http）

func (h *UserHandler) CreateUser(w http.ResponseWriter, r *http.Request) {
    var req CreateUserRequest
    if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
        writeError(w, http.StatusBadRequest, "invalid_json", "Invalid request body")
        return
    }

    if err := req.Validate(); err != nil {
        writeError(w, http.StatusUnprocessableEntity, "validation_error", err.Error())
        return
    }

    user, err := h.service.Create(r.Context(), req)
    if err != nil {
        switch {
        case errors.Is(err, domain.ErrEmailTaken):
            writeError(w, http.StatusConflict, "email_taken", "Email already registered")
        default:
            writeError(w, http.StatusInternalServerError, "internal_error", "Internal error")
        }
        return
    }

    w.Header().Set("Location", fmt.Sprintf("/api/v1/users/%s", user.ID))
    writeJSON(w, http.StatusCreated, map[string]any{"data": user})
}

API設計チェックリスト

新しいエンドポイントをリリースする前に:

• リソースURLが命名規則に従っている（複数形、ケバブケース、動詞なし）
• 正しいHTTPメソッドが使用されている（読み取りはGET、作成はPOSTなど）
• 適切なステータスコードが返されている（すべてに200を使わない）
• 入力がスキーマで検証されている（Zod、Pydantic、Bean Validation）
• エラーレスポンスがコードとメッセージを含む標準フォーマットに従っている
• リストエンドポイントにページネーションが実装されている（カーソルまたはオフセット）
• 認証が必要（または明示的に公開とマークされている）
• 認可がチェックされている（ユーザーは自分のリソースにのみアクセス可能）
• レート制限が設定されている
• レスポンスが内部詳細を漏洩していない（スタックトレース、SQLエラー）
• 既存のエンドポイントと命名が一貫している（camelCase vs snake_case）
• ドキュメント化されている（OpenAPI/Swagger仕様が更新されている）