Как установить 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/

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

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

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

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

    Примечание. Убедитесь, что флажок encrypted (зашифровано) не установлен.

    • Добавьте ключ 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-адресам. В значения allowed_hosts следует включать только имена хостов и IP-адреса конечных точек API, задокументированные в SmartDocs.