SmartDocs のインストール

インストールをテストするで説明されているように、SmartDocs は、インストール テスト スクリプトをインストールして実行するときに自動的にインストールされます。テスト スクリプトを実行する際に次のコマンドを実行します。

/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile

ここで、configFile は Edge のインストールに使用したのと同じ構成ファイルです。詳細については、ノードに Edge コンポーネントをインストールするをご覧ください。

このコマンドは、テストの実行中に SmartDocs をインストールします。

インストールを完了するには:

  1. SmartDocs がインストールされていることを確かめるため、smartdocs.zip ファイルが次のディレクトリに存在することを確認します。

    /opt/apigee/apigee-validate/bundles/

    または、Management Server ノードで次の API 呼び出しを実行します。

    curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis

    SmartDocs がインストールされていれば、このコマンドによって次の出力が返されます。

    [ "smartdocs", "passthrough" ]
  2. 以下の図に示すように、Edge UI から「smartdocs_whitelist」という名前の KVM を作成して更新します。KVM は、SmartDocs プロキシが現在デプロイされている組織および環境に作成する必要があります。

    : [暗号化] チェックボックスがオフになっていることを確認します。

    • 「is_whitelist_configure」という名前のキーを追加し、値を「YES」にします。
    • 「allowed_hosts」という名前の 2 つ目のキーを追加し、値には SmartDocs から呼び出されるホスト名または IP アドレスをスペース区切りで指定します。「allowed_hosts」の値には、SmartDocs に追加された OpenAPI 仕様に含まれるホストを含める必要があります。たとえば、OpenAPI 仕様から mocktarget.apigee.net が呼び出される場合は、「allowed_hosts」の値に mocktarget.apigee.net を追加する必要があります。KVM にホストが 1 つも含まれていない場合、SmartDocs からのレスポンスは 400 Bad Request になり、そのコンテンツ ペイロードには Bad Request-Hostname not permitted が含まれます。
    KVM 作成インターフェース : この KVM を追加して構成しないと、プロキシで許可リストが適用されません。その結果、ホストと IP アドレスへの不正なアクセスが発生する可能性があります。「allowed_hosts」の値には、SmartDocs で文書化された API エンドポイントのホスト名と IP アドレスのみを含めてください。