Общие сведения об устранении неполадок на портале для разработчиков на основе Drupal

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X.
Информация

Поставщику API необходимо предоставить разработчикам доступ к API, обучить их работе с ним, зарегистрировать их и их приложения. Apigee Edge предоставляет портал сервисов для разработчиков, который можно использовать для создания и запуска собственного сайта, чтобы предоставлять эти сервисы сообществу разработчиков. Чтобы узнать больше о порталах для разработчиков, прочитайте статью Что такое портал для разработчиков?

В следующих разделах описаны основные понятия, которые необходимо знать, чтобы устранять неполадки с порталом для разработчиков.

Как работает SmartDocs

Спецификацию OpenAPI (JSON или YAML) или WADL, описывающую ваш API, можно импортировать в SmartDocs и использовать для публикации справочной документации по API на вашем портале. Справочная документация по API автоматически появляется на вкладке API на вашем портале. Разработчики находят документацию по API на портале и могут отправлять запросы к API в реальном времени. Поскольку запросы к API поступают из браузера, для их успешного выполнения требуется поддержка CORS (совместного использования ресурсов между разными источниками). Поддержка CORS обеспечивается прокси-сервером smartdocs в Edge (в организации VALIDATE), который действует как прокси-сервер для всех запросов SmartDocs к нужной конечной точке. Прокси-сервер smartdocs создается при установке SmartDocs.

Пример:

URL прокси-сервера SmartDocs доступен как настраиваемое свойство в разделе "Конфигурация > SmartDocs > URL прокси-сервера SmartDocs". Возможно, вам потребуется изменить этот URL, если ваш API находится в частной сети и живые запросы API с использованием SmartDocs из вашего портала завершаются неудачно.


Как портал для разработчиков взаимодействует с Edge

Большая часть информации, которая показывается на портале для разработчиков, хранится в Edge и извлекается оттуда. Это касается, в частности, SmartDocs, разработчиков, продуктов и приложений разработчиков. Информацию об организации Edge и учетные данные devadmin можно настроить с помощью команды меню Configuration -> Devportal (Конфигурация > Портал разработчика).

Подробнее о взаимодействии между порталом и Edge…