Citrix Application Delivery Managementサービス

API 定義を作成またはアップロードする

API定義は、OpenAPI仕様規格(Swagger 2.0、OpenAPI 3.0.x)を用いてAPIを記述した文書である。この定義には、API リソースパスとそれらを操作するメソッドを含めることができます。API定義をADMに追加し、APIゲートウェイ(Citrix ADC)に展開できます。

API 定義は、次のいずれかの方法で作成できます。

注:

現在、ADM は Swagger 2.0 または openapi 3.0.1を使用する OAS 仕様ファイルの解析をサポートしています。

OAS 仕様をアップロードする

OAS 仕様は ADM GUI にアップロードできます。

  1. アプリケーション」>「API Gateway」>「API定義」に移動します。

  2. [追加] をクリックします。

  3. OAS仕様のアップロード」を選択します。

    注:

    OAS 仕様ファイルが YAML または JSON 形式であることを確認します。また、このファイルに外部参照を含めることはできません。現在、ADM は Swagger バージョン 2.0 をサポートしています。

  4. ローカルコンピュータから OAS 仕様を参照し、ADM にアップロードします。

API 定義を作成する

ADM GUI で独自の API 定義を作成できます。

  1. アプリケーション」>「API Gateway」>「API定義」に移動します。

  2. [追加] をクリックします。

  3. [ 定義を作成 ] を選択し、次の項目を指定します。

    • 名前 -API定義の名前。

    • API 定義 -定義には、タイトル、バージョン、ベースパス、およびホストを含める必要があります。[ Host ] フィールドで、ドメイン名または IP アドレスを指定できます。

    • API リソース -定義に複数の API リソースを追加します。各リソースには、パスとサポートされているメソッドがあります。

    API 定義を作成する

  4. [作成] をクリックします。

API 定義の表示

[ API 定義 ] ページには、アップロードされた定義が一覧表示されます。[ 表示 ] をクリックして、次の API 定義の詳細を表示します。

  • 「名前 」-API 定義の名前を表示します。

  • API 定義」-定義のタイトル 、バージョン、ベースパス、ホストを表示します。

  • API リソース — API 定義内の API リソースと、それらを操作するためのメソッドを一覧表示します。

次に、この定義を API ゲートウェイにデプロイします。

API 定義を作成またはアップロードする