APIプロキシコレクション
APIプロキシコレクションは、受信リクエストを既存のAPIバックエンドに転送します。 各プロキシエンドポイントは、クライアントとAPIサーバーの間の安全な仲介役として機能します。
プロキシコレクションを使用して、次を実行できます:
- 既存のAPIに監視とアクセス制御を追加
- プロキシ認証で内部APIを保護
- 大量トラフィックのレイテンシを最小化
コレクションタイプ
プロキシ、レシピ、およびAIゲートウェイコレクションを比較するには、コレクションタイプを選択を参照してください。
前提条件
APIプロキシコレクションを作成する前に、次の設定を完了します:
- プロジェクトを作成するか、既存のプロジェクトを選択します。
- リクエストを転送するためのHTTPコネクションを作成します。
APIプロキシコレクションの作成
APIプロキシコレクションを作成するには、次の手順を完了します:
Workatoアカウントにサインインします。
プラットフォーム>API platform>APIコレクションに移動します。
+ 新しいコレクションを作成を選択します。
どのタイプのコレクションを作成しますかフィールドに移動し、APIプロキシコレクションを選択します。
APIプロキシコレクションを選択
コレクションをホストするゲートウェイをAPIゲートウェイフィールドで選択します。 このフィールドは、Edge Gatewayを設定した後にのみ表示されます。 マネージドホスティングを使用するにはWorkatoクラウドゲートウェイを選択し、オンプレミスでリクエストを処理するにはエッジゲートウェイを選択します。
ターゲットHTTPコネクションを選択を使用して、リストから既存のHTTPコネクションを選択するか、HTTPコネクションを作成を参照して新規作成します。 コネクションの設定を表示するには、詳細を選択します。
リクエストの転送先HTTPコネクションを選択
サポートされている認証タイプ
APIプロキシコレクションでは、次のHTTPコネクション認証タイプがサポートされています:
- 認証なし
- クエリ
- Basic
- ヘッダー
- OAuth 2.0(クライアント資格情報グラント)
- AWS IAMロール認証
- AWSアクセスキー認証
サポートされていない認証タイプを選択すると、Workatoにサポートされていない認証タイプエラーメッセージが表示されます。
プロキシがDynamoDBやS3などのAWSサービスにリクエストを転送する場合は、AWS IAMロール認証またはAWSアクセスキー認証を使用します。
設定タイプを選択して、プロキシコレクションで使用する予定の設定を指定します:
OpenAPI Specificationをインポート:JSONまたはUTF-8エンコードのYAML OpenAPI 3.0ファイルをアップロードするか、そのURLを入力します。 Workatoはこの仕様を使用して、エンドポイントスキーマを自動的に生成します。 時間値は引用符で囲む必要があります。 たとえば、
2024-07-18T10:00:00Zではなく、"2024-07-18T10:00:00Z"を使用します。手動設定:Workatoは、後でエンドポイントを追加できる空のコレクションを作成します。 詳細は、スキーマの設定を参照してください。
OPENAPIのみ
このステップは、設定中にOpenAPI仕様をインポートした場合のみ適用されます。
エンドポイントをカスタマイズに移動し、コレクションに追加する各エンドポイントの横にあるチェックボックスを選択します。
任意です。 エンドポイントの横にある詳細を編集を選択して、その設定を構成します。
エンドポイント名を入力します。
APIプロキシコレクションエンドポイントをカスタマイズ
エンドポイントパスフィールドでエンドポイントのパスを定義します。 パスパラメータを含めることができます。 エンドポイントパスのガイドラインに従っていることを確認してください。
エンドポイントに使用するHTTPメソッドを選択します。
タイムアウトをカスタマイズをオンにすると必須です。 リクエストタイムアウトフィールドで、リクエストの完了に許可する時間をカスタマイズします。 デフォルト値は30秒、最大値は240秒です。
次へをクリックしてコレクションの詳細を設定ページに移動し、次を入力します:
APIコレクションのコレクション名を入力します。
コレクションの詳細を設定
バージョンを入力します。 1~10文字の一意の識別子を使用します。 同じ名前でバージョンが異なるコレクションは、別個のオブジェクトとして扱われます。
APIコレクションの説明を入力します。
コレクションを作成を選択します。 Workatoはコレクションを作成し、追加されたエンドポイント数を表示します。
APIコレクションを表示を選択します。
新しいコレクションで使用する予定のエンドポイントを有効化するには、非アクティブボタンを切り替えます。
新しいエンドポイントはデフォルトで非アクティブ
すべての新しいエンドポイントは、デフォルトで非アクティブです。 レシピまたはアプリがエンドポイントを呼び出す前に、エンドポイントを有効化する必要があります。
コレクション内のAPIプロキシエンドポイントを有効化
エンドポイントの有効化の詳細については、エンドポイントの有効化または無効化を参照してください。
特定のユーザーまたはアプリにアクセス権を付与するには、このコレクションをクライアントアクセスプロファイルに割り当てます。 新しいアクセスプロファイルの作成方法。
Last updated: