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

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

На этом этапе вы опубликуете 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. На странице «Спецификации» наведите курсор на спецификацию 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. Нажмите + Продукт API .
    Откроется страница «Новый продукт».
  3. Введите сведения о продукте для вашего продукта API.
    Примечание . Поля «Отображаемое имя» и «Описание» по умолчанию отображаются на портале при публикации продукта API. Вы можете изменить значения на шаге 4. Опубликуйте API на своем портале .
    Поле Ценить
    Имя Привет, мир
    Отображаемое имя Привет, мир
    Описание Простой пример приветствия, мир
    Среда Выберите среду, в которой развернут прокси-сервер API.
    Доступ Общественный
    Автоматически утверждать запросы на доступ Включено
    Квота (оставьте пустым)
    Разрешенные области действия OAuth (оставьте пустым)
  4. В разделе «Ресурсы API» нажмите «Добавить прокси» , чтобы определить прокси API, которые нужно добавить в ваш продукт API.
    Откроется диалоговое окно «Добавить ресурс API» .
  5. Нажмите API-прокси (если он еще не выбран) и выберите в списке Mock-Target-API .
  6. Нажмите Добавить .
  7. Нажмите «Сохранить» , чтобы сохранить продукт API.

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

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

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

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

  1. Перейдите на страницу API на вашем портале:
    1. Выберите «Опубликовать» > «Порталы» на левой панели навигации.
    2. Щелкните строку « Мой первый портал», чтобы открыть портал.
    3. Нажмите «Каталог API» , чтобы отобразить страницу API.
  2. Нажмите + .
  3. Выберите «Hello World» в диалоговом окне «Добавить продукт API в каталог» и нажмите «Далее» .
  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!

Mock Target API опубликован с панелью «Попробуйте этот API»

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