Zainstaluj SmartDokumenty

Funkcja SmartDocs jest instalowana automatycznie podczas instalowania i uruchamiania skryptów testowych instalacji opisanych w sekcji Testowanie instalacji. W ramach uruchamiania skryptów testowych wykonaj te polecenia:

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

Gdzie configFile to ten sam plik konfiguracji, który został użyty do zainstalowania Edge. Więcej informacji znajdziesz w artykule Instalowanie komponentów Edge w węźle.

To polecenie instaluje SmartDocs w ramach testów.

Aby dokończyć instalację:

1. Sprawdź, czy usługa SmartDocs jest zainstalowana, potwierdzając, że plik smartdocs.zip znajduje się w tym katalogu:

   /opt/apigee/apigee-validate/bundles/

   Możesz też uruchomić to wywołanie interfejsu API w węźle serwera zarządzania:

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

   Jeśli usługa SmartDocs jest zainstalowana, to polecenie powinno zwrócić te informacje:

   [ "smartdocs", "passthrough" ]

2. W interfejsie Edge utwórz i zaktualizuj KVM o nazwie „smartdocs_whitelist”, jak pokazano na ilustracji poniżej. KVM należy utworzyć w organizacji i środowisku, w którym obecnie wdrożony jest serwer proxy SmartDocs.

   Uwaga: upewnij się, że pole encrypted (zaszyfrowane) NIE jest zaznaczone.

   • Dodaj klucz o nazwie „is_whitelist_configured” z wartością „YES”.
   • Dodaj drugi klucz o nazwie „allowed_hosts”, którego wartościami są rozdzielone spacjami nazwy hostów lub adresy IP wywoływane z SmartDocs. Wartość „allowed_hosts” powinna zawierać wszystkie hosty uwzględnione w specyfikacjach OpenAPI dodanych do SmartDocs. Jeśli na przykład masz specyfikację OpenAPI, która wywołuje mocktarget.apigee.net, musisz dodać mocktarget.apigee.net do wartości „allowed_hosts”. Jeśli host nie jest uwzględniony w KVM, odpowiedź SmartDocs będzie miała wartość 400 Bad Request z ładunkiem treści Bad Request-Hostname not permitted.
   Uwaga: jeśli nie dodasz i nie skonfigurujesz tej maszyny KVM, serwer proxy nie będzie wymuszać stosowania listy dozwolonych. Może to spowodować nieautoryzowany dostęp do Twoich hostów i adresów IP. Wartości „allowed_hosts” powinny zawierać tylko nazwy hostów i adresy IP punktów końcowych interfejsu API udokumentowanych w SmartDocs.