APIコレクション管理のFAQ ​

APIコレクションは、共通のアクセスパターンを共有するAPIエンドポイントのグループであり、まとめて管理できます。 APIコレクションは、関連するエンドポイントを効率的に整理および管理するために使用されます。

APIコレクションページにアクセスするには、次の手順を実行します。

Workatoで利用可能なAPIコレクションの種類は3つあります。

• APIプロキシコレクション
• APIレシピコレクション
• AIゲートウェイコレクション

APIレシピコレクションは、個別のAPIレシピから作成されたエンドポイントで構成され、1つのレシピが1つのエンドポイントに対応します。 APIレシピコレクションを使用すると、Workatoアカウントを持たないユーザーを含む内部および外部ユーザーの両方が、強力なAPIエンドポイントにアクセスできるようになります。

APIレシピコレクションを作成する前に、プロジェクトを作成し、プロジェクト内にフォルダを作成して、1つ以上のAPIレシピをフォルダに追加する必要があります。

APIプロキシコレクションには、APIクライアントとサーバーの間の仲介役として機能するプロキシエンドポイントが含まれます。 これにより、内部APIにセキュリティと制御のレイヤーが追加されます。 これにより、アクセス制御機能の管理と監視が容易になります。

APIプロキシコレクションを作成するには、プロジェクトを作成し、リクエストの転送先となるHTTPコネクションを設定する必要があります。

どちらを選択するかはユースケースによって異なります。 APIレシピコレクションは、独自のバックエンドを構築し、データ取得と処理をカスタマイズする予定がある場合に適しています。 APIプロキシコレクションは、既存のバックエンドAPIに最小限のレイテンシでリクエストを転送する場合に最適です。

APIコレクション設定を見つけて構成するには、次の手順を実行します。

構成設定には次のものが含まれます。

• バージョンタグ
• 説明
• URL設定
• 共有オプション
• コレクションをPostmanに同期する機能

APIコレクションをPostmanと同期するには、次の手順を実行します。

はい、APIコレクションではOpenAPI仕様形式の機械可読ドキュメントを利用できます。 APIコレクションページの右上隅から、APIコレクションのOpenAPI仕様をダウンロードできます。