API Gateway Configuration

目次

• 概要
• 使用時機
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

マイクロサービスアーキテクチャ向けのAPIゲートウェイを設計・構成して、ルーティング、認証、レート制限、リクエスト/レスポンス変換を処理します。

使用時機

• マイクロサービス向けリバースプロキシの設定
• API認証の一元化
• リクエスト/レスポンス変換の実装
• バックエンドサービス間のトラフィック管理
• レート制限とクォータ強制
• APIバージョニングとルーティング

クイックスタート

最小限の動作例:

# kong.yml - Kong Gateway configuration
_format_version: "2.1"
_transform: true

services:
  - name: user-service
    url: http://user-service:3000
    routes:
      - name: user-routes
        paths:
          - /api/users
          - /api/profile
    plugins:
      - name: rate-limiting
        config:
          minute: 100
          policy: local
      - name: jwt
        config:
          secret: your-secret-key
          key_claim_name: "sub"
      - name: cors
        config:
          origins:
            - "http://localhost:3000"
// ... (see reference guides for full implementation)

リファレンスガイド

references/ ディレクトリ内の詳細実装:

ベストプラクティス

✅ DO (推奨)

• ゲートウェイレベルで認証を一元化する
• グローバルレート制限を実装する
• 包括的なログを追加する
• バックエンドのヘルスチェックを使用する
• 適切な場合はレスポンスをキャッシュする
• サーキットブレーカーを実装する
• ゲートウェイメトリクスを監視する
• 本番環境ではHTTPSを使用する

❌ DON'T (非推奨)

• バックエンドサービスの詳細を公開しない
• リクエスト検証をスキップしない
• API使用ログを忘れない
• 弱い認証を使用しない
• 動的データをキャッシュしすぎない
• バックエンドのタイムアウトを無視しない
• セキュリティヘッダーをスキップしない
• 内部IPを公開しない