API定義の作成またはアップロード
API定義は、OpenAPI Specification標準を使用してAPIを記述するドキュメントです。この定義には、APIリソースのパスと、それらを操作するためのメソッドを含めることができます。API定義をNetScaler Consoleに追加し、APIゲートウェイ(NetScaler)にデプロイできます。
API定義は、以下のいずれかの方法で作成できます。
注:
現在、NetScaler Consoleは、Swagger 2.0またはOpenAPI 3.0.1を使用するOAS仕様ファイルの解析をサポートしています。
OAS仕様のアップロード
NetScaler Console GUIにOAS仕様をアップロードできます。
-
Security > API Security > API Definitionsに移動します。
-
追加をクリックします。
-
OAS仕様のアップロードを選択します。
注:
OAS仕様ファイルがYAMLまたはJSON形式であることを確認してください。また、このファイルには外部参照を含めないでください。
-
ローカルコンピューターからOAS仕様を参照し、NetScaler Consoleにアップロードします。
API定義の作成
NetScaler Console GUIで独自のAPI定義を作成できます。
-
Security > API Security > API Definitionsに移動します。
-
追加をクリックします。
-
独自の定義の作成を選択し、以下を指定します。
-
名前 - API定義の名前。
-
API定義 - 定義には、タイトル、バージョン、ベースパス、ホストを含める必要があります。ホストフィールドにはドメイン名またはIPアドレスを指定できます。
-
APIリソース - 定義に複数のAPIリソースを追加します。各リソースにはパスとサポートされるメソッドがあります。追加をクリックします。リソースは追加されたリソーステーブルに追加されます。APIリソースを削除するには、削除をクリックします。
-
-
作成をクリックします。
API定義の表示
API定義ページには、アップロードされた定義が一覧表示されます。以下のAPI定義の詳細を表示するには、表示をクリックします。
-
名前 – API定義の名前を表示します。
-
API定義 – 定義のタイトル、バージョン、ベースパス、ホストを表示します。
-
APIリソース – API定義内のAPIリソースと、それらを操作するためのメソッドを一覧表示します。