基本概念

エンドポイント定義

エンドポイント定義は、ヘッダー、クエリ、パス、本文のパラメーターを受け取り、それらのパラメーターで Foundry の関数またはアクションを呼び出す API エンドポイントを定義します。エンドポイント定義は、単一のエンドポイントセットに属します。

エンドポイントセット

エンドポイントセットは、関連するエンドポイントをグループ化するための Compass リソースです。このリソースは、開発者がエンドポイント定義を閲覧、編集、公開、デプロイするための権限を管理します。エンドポイントセットのエンドポイント定義は、設定タブで操作できます。

サブドメイン

エンドポイントを提供するには、事前に Control Panel でサブドメインを登録し、承認を受ける必要があります。サブドメインは、デプロイされたエンドポイントリリースにアクセスするためのカスタムドメインを提供します。

新しいエンドポイントセットを作成すると、サブドメインを登録するための入力画面が表示されます。サブドメインをエンドポイント定義にリンクするには、エンドポイントセットごとにサブドメインを登録する必要があります。Custom Endpoints は、Control Panel で手動作成された独立したサブドメインに対応していません。

エンドポイントセットの公開とリリース

バージョン付きのスナップショットを作成するには、まずエンドポイントセットを公開する必要があります。エンドポイントセットを公開すると、セマンティックバージョンに紐づけられた変更不可のリリースが作成されます。この操作は Git の使用に似ています。公開時には、git commit と同様に現在の状態を記録し、git tag と同様にセマンティックバージョンのタグを割り当てます。エンドポイントセットの各リリースは変更できませんが、削除はできます。

エンドポイントセットのリリースをデプロイする

エンドポイントは、エンドポイントセットのリリースをサブドメインにデプロイした後にのみアクセスできるようになります。複数のリリースを同時にデプロイできます。リクエストでは、endpoint-api-version ヘッダーで指定されたバージョンが使用されます。指定がない場合は、デプロイ済みの最新バージョンがデフォルトで使用されます。