Шаг 6: Опубликуйте API

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

На этом этапе вы опубликуете API на портале, выполнив следующие действия:
1. Создайте спецификацию OpenAPI .
2. Создайте API-прокси на основе спецификации.
3. Создайте API-продукт.
4. Опубликуйте API на своем портале.

Шаг 1: Создайте спецификацию OpenAPI.

Каждая спецификация OpenAPI служит источником достоверной информации на протяжении всего жизненного цикла API. Одна и та же спецификация используется на каждом этапе жизненного цикла API, от разработки до публикации.

Для создания спецификации OpenAPI :

  1. Чтобы открыть страницу «Технические характеристики» , выберите в левой панели навигации пункт «Разработка» > «Технические характеристики» .
  2. Нажмите + Спецификация > Импорт URL .
  3. В диалоговом окне импорта введите следующую информацию:
  4. Имя импорта: helloworld

  5. URL для импорта: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. Нажмите «Импорт» .

Шаг 2: Создайте API-прокси на основе спецификации.

Создайте прокси-сервер API на основе спецификации OpenAPI, описывающей API.

Для создания API-прокси на основе спецификации OpenAPI :

  1. На странице «Specs» наведите курсор на спецификацию helloworld , чтобы отобразить меню действий.
  2. Нажмите для генерации API-прокси на основе спецификации.
    Открывается мастер создания прокси-сервера, и страница с подробными сведениями заполняется значениями из спецификации OpenAPI.
  3. Отредактируйте поле «Описание» следующим образом: API-прокси для "hello world".
  4. Нажмите «Далее» .

  5. На странице «Политика» :

    • В разделе «Безопасность: Авторизация» выберите «Сквозная авторизация (без авторизации)» .
    • В разделе «Безопасность: Браузер» выберите «Добавить заголовки CORS» .

    На странице «Общие политики» мастера создания прокси-сервера выбраны параметры «Сквозная передача» и «Добавить заголовки CORS».

  6. Нажмите «Далее» .

  7. На странице «Потоки» убедитесь, что выбраны все операции, и нажмите «Далее» .
    Создание прокси-потоков

  8. На странице «Виртуальные хосты» убедитесь, что выбраны все виртуальные хосты, и нажмите «Далее» .

  9. На странице «Сводка» в разделе «Дополнительное развертывание» выберите среду, в которую вы хотите выполнить развертывание.

  10. Нажмите «Создать» .

На странице «Сводка» вы увидите подтверждение того, что ваш новый API-прокси был успешно создан и развернут в вашей тестовой среде.

Шаг 3: Создайте API-продукт

Создайте API-продукт, содержащий ресурсы API, которые вы хотите предоставить своим потребителям API.

Для создания API-продукта :

  1. Чтобы открыть страницу «Продукты API», выберите в левой панели навигации пункт «Опубликовать» > «Продукты API».
  2. Click + API Product .
    Отображается страница «Новый продукт».
  3. Введите подробные сведения о вашем API-продукте.
    Примечание : Поля «Отображаемое имя» и «Описание» по умолчанию отображаются на портале при публикации продукта API. Вы можете изменить значения на шаге 4: Публикация API на вашем портале .
    Поле Ценить
    Имя Привет, мир
    Отображаемое имя Привет, мир
    Описание Простой пример "Hello World"
    Среда Выберите среду, в которой развернут API-прокси.
    Доступ Общественный
    Автоматическое одобрение запросов на доступ Включено
    Квота (оставьте пустым)
    Разрешенные области действия OAuth (оставьте пустым)
  4. В разделе «Ресурсы API» нажмите «Добавить прокси» , чтобы указать прокси API, которые необходимо добавить к вашему продукту API.
    Отобразится диалоговое окно «Добавить ресурс API» .
  5. Нажмите «API Proxy» (если он еще не выбран) и выберите Mock-Target-API в списке.
  6. Нажмите «Добавить» .
  7. Нажмите «Сохранить» , чтобы сохранить продукт API.

    API-продукт Hello World, отображающий все заданные поля.

Шаг 4: Опубликуйте API на своем портале.

Опубликуйте API на своем портале, чтобы ваши клиенты могли узнать о нем и использовать его.

Чтобы опубликовать API на своем портале :

  1. Перейдите на страницу API в вашем портале:
    1. В левой панели навигации выберите «Публикация» > «Порталы» .
    2. Чтобы открыть портал, нажмите на первую строку раздела «Мой портал» .
    3. Нажмите «Каталог API» , чтобы отобразить страницу API.
  2. Нажмите + .
  3. В диалоговом окне «Добавить продукт API в каталог» выберите «Hello World» и нажмите «Далее» .
  4. В разделе «Подробности API» настройте следующие параметры:
    • Выберите «Опубликовано» (в списке каталога) , чтобы опубликовать API на вашем портале.
    • Для отображения изображения :
      1. Нажмите «Выбрать изображение» .
      2. В диалоговом окне «Выбрать изображение» выберите изображение home-background.jpg из списка доступных изображений.
      3. Нажмите «Выбрать» .
      4. Предварительно просмотрите изображение и нажмите «Выбрать» .
    • В поле «Категории» введите «Начать » и нажмите Enter .

    Оставьте все остальные значения по умолчанию.

  5. В разделе «Документация API» можно автоматически сгенерировать справочную документацию по API на основе снимка вашей спецификации OpenAPI:
    1. Выберите документ OpenAPI .
    2. Нажмите «Выбрать документ» .
    3. Выберите вкладку «Мои характеристики» (если она еще не выбрана).
    4. Выберите helloworld из списка характеристик.
    5. Нажмите «Выбрать» .
  6. Нажмите «Сохранить» , чтобы сохранить данные API.

    API "Hello World" отображает все установленные поля.

Для просмотра справочной документации по API:

  1. Нажмите «Портал в реальном времени» , чтобы просмотреть изменения в портале (или обновите страницу портала, если она уже открыта в другой вкладке).
  2. Чтобы просмотреть опубликованные API, нажмите «API» в верхней панели навигации.
  3. Нажмите на карточку "Hello World" , чтобы просмотреть справочную документацию по API. Попробуйте свой API!

Имитационный целевой API, опубликованный с помощью панели «Попробовать этот API».

Поздравляем! Вы успешно завершили обучающий курс. Готовы узнать больше? Перейдите в раздел «Создание интегрированного портала» .