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

最終公開日 : Oct 02, 2026
API定義は、OpenAPI Specification標準を使用してAPIを記述するドキュメントです。この定義には、APIリソースパスとそれらを操作するためのメソッドを含めることができます。API定義をNetScaler Consoleに追加し、APIゲートウェイ (NetScaler) に展開できます。
API定義は、次のいずれかの方法で作成できます。
注:
現在、NetScaler Consoleは、Swagger 2.0 または openapi 3.0.1 を使用するOAS仕様ファイルの解析をサポートしています。
Related information
APIセキュリティ

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

OAS仕様はNetScaler Console GUIにアップロードできます。
  1. Security > API Security > API Definitions に移動します。
  2. Add をクリックします。
  3. Upload OAS Specification を選択します。
    注:
    OAS仕様ファイルがYAMLまたはJSON形式であることを確認してください。また、このファイルには外部参照を含めないでください。
  4. ローカルコンピューターからOAS仕様を参照し、NetScaler Consoleにアップロードします。

API定義を作成する

NetScaler Console GUIで独自のAPI定義を作成できます。
  1. Security > API Security > API Definitions に移動します。
  2. Add をクリックします。
  3. Create Your Definition を選択し、以下を指定します。
    • 名前 - API定義の名前。
    • API定義 - 定義には、タイトル、バージョン、ベースパス、ホストを含める必要があります。ホスト フィールドには、ドメイン名またはIPアドレスを指定できます。
    • APIリソース - 定義に複数のAPIリソースを追加します。各リソースにはパスとサポートされているメソッドがあります。Add をクリックします。リソースは Added Resources テーブルに追加されます。APIリソースを削除するには、Delete をクリックします。
    API定義を作成する(/en-us/netscaler-console-service/media/create-an-api-definition.png)
  4. Create をクリックします。

API定義を表示する

API定義 ページには、アップロードされた定義が一覧表示されます。View をクリックして、以下のAPI定義の詳細を表示します。
  • 名前 – API定義の名前を表示します。
  • API定義 – 定義のタイトル、バージョン、ベースパス、ホストを表示します。
  • APIリソース – API定義内のAPIリソースと、それらを操作するためのメソッドを一覧表示します。