Установить СмартДоки

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/

    Или выполните следующий вызов API на узле Management Server:

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

    Эта команда должна вернуть следующее, если SmartDocs установлен:

    [ "smartdocs", "passthrough" ]
  2. В пользовательском интерфейсе Edge создайте и обновите KVM с именем «smartdocs_whitelist», как показано на рисунке ниже. KVM должен быть создан в организации и среде, в которой в настоящее время развернут прокси SmartDocs.

    Примечание . Убедитесь, что флажок для шифрования НЕ установлен.

    • Добавьте ключ с именем «is_whitelist_configured», где значение «YES».
    • Добавьте второй ключ с именем «allowed_hosts», где значения представляют собой разделенные пробелами имена хостов или IP-адреса, вызываемые из SmartDocs. Значение «allowed_hosts» должно включать любые хосты, включенные в спецификации OpenAPI, добавленные в SmartDocs. Например, если у вас есть спецификация OpenAPI, которая вызывает mocktarget.apigee.net , вам нужно будет добавить mocktarget.apigee.net к значению «allowed_hosts». Если хост не включен в KVM, ответ SmartDocs будет 400 Bad Request с полезной нагрузкой содержимого Bad Request-Hostname not permitted .
    Интерфейс создания KVM Примечание . Если вы не добавите и не настроите этот KVM, прокси-сервер не будет применять белый список. Это может привести к несанкционированному доступу к вашим хостам и IP-адресам. Только имена хостов и IP-адреса конечных точек API, задокументированные с помощью SmartDocs, должны быть включены в значения «allowed_hosts».