ゲートウェイおよびポータルの設定の指定

オンラインで編集する

API の一般的な構成設定を定義します。

このタスクについて

注: このタスクは、 OpenAPI 2.0 API 定義の構成に関連しています。 OpenAPI 3.0 API 定義の構成方法について詳しくは、 OpenAPI 3.0 API 定義の編集を参照してください。

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

「ソース 」アイコン OpenAPI ソース・アイコンをクリックすると、いつでも直接、基盤となる OpenAPI のYAMLソースに切り替えることができます。 デザインフォームに戻るには、 フォームアイコンをクリックしてください フォーム・アイコン。

手順

  1. OpenAPI 2.0 API 定義の編集の説明に従って、編集のために API を開きます。
  2. 「ゲートウェイ」 タブを選択し、 「ゲートウェイおよびポータルの設定」をクリックします。
  3. 以下の情報を指定します。
    • ターゲット・サービス: API 定義で使用する Web サービスを定義します。 詳細については、 「API のターゲットサービスの定義」 を参照してください。
    • 強制: DataPower® API Gatewayを使用して API を強制するには、このオプションを選択します。 DataPower API Gateway以外のゲートウェイで API を管理する場合は、このオプションをクリアします。 によってゲートウェイに公開されていないものの API Connect、適用されていないAPIは、アプリケーション開発者がサブスクライブできるよう、 コンシューマーカタログで引き続き利用可能です。
    • フェーズ: API が入っているライフサイクルのフェーズ。以下のいずれかのオプションを選択します。
      • 実現済み (デフォルト)- API は実装フェーズにあります。
      • 識別済み - API は初期の概念フェーズにあり、完全には設計も実装もされていません。
      • 指定済み - API は完全に設計され、内部のマイルストーンを通過しましたが、まだ実装されていません。
    • テスト可能 ：このオプションを選択すると、 Consumer Catalog のテストツールを使用して API の操作をテストできるようになります。
      注: テスト・ツールが機能するには、カタログにステージングされている製品のプランに API が含まれている必要があります。
    • CORS: API の Cross-Origin Resource Sharing (CORS) サポートを有効にして構成します。 詳細については、 「API での CORS のサポートを有効にする」 を参照してください。
    • プロパティー: プロパティーを追加します。このプロパティーは、API 定義で参照できます。 詳細については、 「API プロパティの設定」 を参照してください。
    • カタログ・プロパティー: 特定のカタログに固有のプロパティー値を定義します。 詳細については、 「カタログ固有のプロパティ値の定義」 を参照してください。
    • ゲートウェイ ：詳細については、 「API定義のゲートウェイタイプの指定」 を参照してください。
    • アプリケーション認証: アプリケーション認証を有効にして、証明書を使用して API を保護します。 詳細については、 「API のアプリケーション認証の設定」 を参照してください。
    • アプリケーション認証ソース: アプリケーション認証が有効になっている場合、クライアント証明書をゲートウェイに送信する方法を指定します。 詳細については、 「API のアプリケーション認証の設定」 を参照してください。
    • アクティビティー・ログ: 分析に保管されている API アクティビティー用にロギングの設定を構成します。 詳細については、 「アクティビティのログ設定」 を参照してください。
    • HTML ページ: GraphQL API の場合に、API が最初の GraphiQL エディター要求に応答する際に使用する HTML ページ。 現在、唯一のオプションは store:///graphiql.htmlです。 詳細については、 「 GraphQL API での GraphiQL エディタの有効化」 を参照してください。
    • Graphql Schema: GraphQL API の場合、インポートされた GraphQL スキーマを参照するスキーマ定義の名前。 GraphQL APIの作成時にスキーマをアップロードする方法については、 「 GraphQL プロキシAPIの作成」 を参照してください。 既存の GraphQL APIのスキーマを置き換える方法については、 「 GraphQL スキーマエディタの使用」 を参照してください。
    • 排他的緊張: OpenAPI 仕様を拡張するために API に拡張機能が追加されました。 詳細については、 「APIへの OpenAPI 拡張機能の追加」 を参照してください。