Шаг 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. На панели навигации слева выберите Publish > API Products (Опубликовать > Продукты API). Откроется страница API Products (Продукты API).
  2. Нажмите + Продукт API.
    Откроется страница "Новый продукт".
  3. Введите сведения о продукте для продукта API.
    Примечание. По умолчанию поля "Отображаемое имя" и "Описание" показываются на портале при публикации продукта API. Вы можете изменить значения в разделе Шаг 4. Опубликуйте API на портале.
    Поле Значение
    Название Hello World
    Отображаемое название Hello World
    Описание Простой пример "Hello, world!"
    Среда Выберите среду, в которой развернут прокси-сервер API.
    Доступ Общедоступное
    Как автоматически одобрять запросы на доступ Включено
    Квота (оставьте пустым)
    Разрешенные области действия OAuth (оставьте пустым)
  4. В разделе Ресурсы API нажмите Добавить прокси, чтобы указать прокси API, которые нужно добавить в продукт API.
    Откроется диалоговое окно Добавить ресурс API.
  5. Нажмите API Proxy (Прокси API) (если этот вариант ещё не выбран) и выберите в списке 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. Посмотрите изображение и нажмите Выбрать.
    • В поле Categories (Категории) введите Get Started (Начать) и нажмите Ввод.

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

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

    API Hello World со всеми заданными полями

Чтобы посмотреть справочную документацию по API:

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

Целевой API, опубликованный с помощью панели "Попробовать этот API"

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