インストールをテストするで説明されているように、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 がインストールされます。
インストールを完了するには:
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" ]
- 下の図に示すように、Edge UI から「smartdocs_whitelist」という名前の KVM を作成して更新します。この KVM は、SmartDocs プロキシが現在デプロイされている組織および環境に作成する必要があります。
注: [encrypted] チェックボックスがオフになっていることを確認してください。
- 「is_whitelist_components」という名前のキーを追加し、値は「YES」です。
- 「allowed_hosts」という名前の 2 つ目のキーを追加します。値は、ホスト名または IP アドレスをスペースで区切ったものです。
呼び出すことができます。「allowed_hosts」の値OpenAPI 仕様に含まれているホストを含める必要がある
SmartDocs に追加されます。たとえば、OpenAPI 仕様から
mocktarget.apigee.netが呼び出される場合は、「allowed_hosts」の値にmocktarget.apigee.netを追加する必要があります。ホストが KVM に含まれている場合、SmartDocs のレスポンスは内容を含む400 Bad Requestになります。Bad Request-Hostname not permittedのペイロードです。
注: この KVM を追加して構成しないと、プロキシで許可リストが適用されません。この
ホストや IP アドレスへの不正アクセスが発生する可能性があります。「allowed_hosts」の値には、SmartDocs で文書化された API エンドポイントのホスト名と IP アドレスのみを含めてください。