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.zipファイルが次の状態であることを確認して、SmartDocs がインストールされていることをテストします。 次のディレクトリにあります。/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 に追加されます。たとえば、
mocktarget.apigee.netを呼び出す OpenAPI 仕様がある場合、mocktarget.apigee.netを「allowed_hosts」に追加する必要があります。あります。ホストが KVM に含まれている場合、SmartDocs のレスポンスは内容を含む400 Bad Requestになります。Bad Request-Hostname not permittedのペイロードです。
注: この KVM を追加して構成しない場合、プロキシは許可リストを適用しません。この
ホストや IP アドレスへの不正アクセスが発生する可能性があります。次のホスト名と IP アドレスのみ:
SmartDocs で文書化された API エンドポイントは、allowed_hosts に含めてください使用できます。