Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Как поставщик API, вам необходим способ предоставления доступа к вашим API, обучения разработчиков работе с ними, регистрации разработчиков и регистрации приложений. Apigee Edge предоставляет вам портал для разработчиков, который вы можете использовать для создания и запуска собственного веб-сайта, предоставляющего эти услуги вашему сообществу разработчиков. Чтобы узнать больше о порталах для разработчиков, см. раздел «Что такое портал для разработчиков?».
В следующих разделах описаны ключевые понятия, которые необходимо понимать перед устранением неполадок в портале разработчика.
Как работает SmartDocs
Спецификация OpenAPI (JSON или YAML) или WADL, описывающая ваш API, может быть импортирована в SmartDocs и использована для публикации справочной документации по API на вашем портале. Справочная документация по API автоматически отображается на вкладке «API» вашего портала. Разработчики находят документацию по API через портал и могут отправлять запросы к API в режиме реального времени. Поскольку запросы к API поступают из браузера, для их успешного выполнения необходима поддержка CORS (Cross-Origin Resource Sharing). Поддержка CORS обеспечивается прокси-сервером «smartdocs» в Edge (в организации «VALIDATE»), который выступает в качестве прокси для всех запросов SmartDocs к нужной конечной точке. Прокси-сервер «smartdocs» создается при установке SmartDocs .
Например:
URL-адрес прокси-сервера SmartDocs доступен в качестве настраиваемого свойства в разделе «Конфигурация» -> «SmartDocs» -> «URL-адрес прокси-сервера SmartDocs». Возможно, вам потребуется изменить этот URL-адрес, если ваш API находится в частной сети, и запросы к API в режиме реального времени через SmartDocs с вашего портала завершаются с ошибкой.
Как портал разработчиков взаимодействует с Edge
Портал разработчиков хранит и извлекает большую часть отображаемой информации из Edge, включая Smartdocs, разработчиков, продукты и приложения для разработчиков. Информация об организации Edge и учетные данные devadmin настраиваются с помощью команды меню «Конфигурация» -> «Портал разработчиков».
Для получения более подробной информации см. раздел «Взаимодействие между порталом и Edge» .