Эта страница переведена с помощью Cloud Translation API.

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

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

Что вы узнаете

В этом уроке вы научитесь:

Создайте прокси-сервер Edge API на основе спецификации OpenAPI.
Вызовите API-прокси с помощью cURL.
Добавьте политику в условный поток.
Проверьте вызов политики с помощью cURL.

В этом руководстве вы узнаете, как создать прокси-сервер Edge API на основе спецификации OpenAPI с помощью пользовательского интерфейса управления Apigee Edge. При вызове прокси-сервера API с помощью HTTP-клиента, например cURL, прокси-сервер API отправляет запрос в фиктивный целевой сервис Apigee.

Об инициативе Open API

«Инициатива Open API (OAI) сосредоточена на создании, развитии и продвижении независимого от поставщиков формата описания API, основанного на спецификации Swagger». Для получения дополнительной информации об инициативе Open API см. https://openapis.org .

Спецификация OpenAPI использует стандартный формат для описания RESTful API. Написанная в формате JSON или YAML, спецификация OpenAPI является машиночитаемой, но при этом легко читается и понимается человеком. Спецификация описывает такие элементы API, как его базовый путь, пути и глаголы, заголовки, параметры запроса, операции, типы контента, описания ответов и многое другое. Кроме того, спецификация OpenAPI часто используется для генерации документации API.

О сервисе имитации целей Apigee

Сервис Apigee mock target, используемый в этом руководстве, размещен на сервере Apigee и возвращает простые данные. Для его работы не требуется ключ API или токен доступа. Более того, вы можете получить к нему доступ через веб-браузер. Попробуйте, перейдя по следующей ссылке:

http://mocktarget.apigee.net

Целевой сервис возвращает приветствие Hello, guest!

Для получения информации о полном наборе API, поддерживаемых службой имитации целевого объекта, нажмите на следующую ссылку:

http://mocktarget.apigee.net/help

Что вам понадобится

Учетная запись Apigee Edge. Если у вас нет учетной записи, вы можете зарегистрироваться, следуя инструкциям в разделе «Создание учетной записи Apigee Edge» .
Спецификация OpenAPI. В этом руководстве вы будете использовать спецификацию OpenAPI mocktarget.yaml , которая описывает сервис имитации целевых объектов Apigee, http://mocktarget.apigee.net . Для получения дополнительной информации см. https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi .
Для выполнения вызовов API из командной строки или веб-браузера на вашем компьютере должен быть установлен cURL .

Создайте API-прокси.

Край

Чтобы создать API-прокси из спецификации OpenAPI с помощью пользовательского интерфейса Edge:

Войдите на сайт https://apigee.com/edge .
В главном окне нажмите «API-прокси».
В качестве альтернативы вы можете выбрать «Разработка» > «API-прокси» в левой панели навигации.
Click + Proxy .
В мастере создания прокси-сервера выберите «Использовать спецификацию OpenAPI» для шаблона обратного прокси (наиболее распространенный) .
Нажмите «Импорт из URL» и введите следующую информацию:
- URL спецификации OpenAPI : Путь к исходному содержимому на GitHub для спецификации OpenAPI в поле URL :
```
https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
```
- Название спецификации : Название спецификации OpenAPI, например, Mock Target .
  Это имя используется для хранения спецификации OpenAPI в хранилище спецификаций. См. раздел «Управление спецификациями» .

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

В мастере создания прокси отображается страница «Подробности». Поля предварительно заполнены значениями, определенными в спецификации OpenAPI, как показано ниже.

В таблице ниже описаны значения по умолчанию, которые предварительно заполняются с использованием свойств, указанных в спецификации OpenAPI. После таблицы приведен фрагмент спецификации OpenAPI, иллюстрирующий используемые свойства.

Поле	Описание	По умолчанию
Имя	Название API-прокси. Например: `Mock-Target-API` .	свойство `title` из спецификации OpenAPI, где пробелы заменены дефисами.
Базовый путь	Компонент пути, который однозначно идентифицирует этот API-прокси в рамках организации. Общедоступный URL этого API-прокси состоит из названия вашей организации, среды, в которой развернут этот API-прокси, и этого базового пути. Например: `http://myorg-test.apigee.net/mock-target-api`	Содержимое поля «Имя» преобразовано в нижний регистр.
Описание	Описание API-прокси.	свойство `description` из спецификации OpenAPI
Целевой объект (существующий API)	Целевой URL-адрес вызывается от имени этого API-прокси. Можно использовать любой URL-адрес, доступный в открытом интернете. Например: `http://mocktarget.apigee.net`	свойства `servers` из спецификации OpenAPI

Ниже приведён фрагмент спецификации OpenAPI, демонстрирующий свойства, используемые для предварительного заполнения полей.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
...
servers:
  - url: http://mocktarget.apigee.net
  - url: https://mocktarget.apigee.net
...

Отредактируйте поле «Описание» следующим образом: API proxy for the Apigee mock target service endpoint.
Нажмите «Далее» .
На странице «Общие политики» в разделе «Безопасность: Авторизация» убедитесь, что выбран параметр «Сквозная авторизация (без авторизации)» , и нажмите «Далее» :
На странице «Потоки» убедитесь, что выбраны все операции.
Совет: Условные потоки генерируются автоматически на основе операций, определенных в объекте paths в спецификации OpenAPI. Условные потоки сообщают Edge: «Когда вы видите это, выполните эту логику». Например, когда вызов API представляет собой GET-запрос к ресурсу /xml (условие), преобразуйте ответ в JSON (с помощью политики, прикрепленной к условному потоку). За одну транзакцию выполняется только один поток — первый поток, условие которого оценивается как истинное.
Нажмите «Далее» .
На странице «Виртуальные хосты» выберите «по умолчанию» и «безопасный» , затем нажмите «Далее» .
На странице «Сводка» убедитесь, что в разделе «Дополнительное развертывание» выбрана тестовая среда, и нажмите «Создать и развернуть» :
Apigee создаст ваш новый API-прокси и развернет его в вашей тестовой среде:
Нажмите «Редактировать прокси» , чтобы отобразить страницу обзора API-прокси.

Классический Edge (частное облако)

Чтобы создать API-прокси из спецификации OpenAPI с помощью классического пользовательского интерфейса Edge:

Войдите на сайт https://apigee.com/edge .
В главном окне нажмите «API-прокси».
В качестве альтернативы вы можете выбрать «Разработка» > «API-прокси» в левой панели навигации.
Click + Proxy .
В мастере создания прокси-сервера выберите «Обратный прокси» (наиболее распространенный вариант) и нажмите « Использовать OpenAPI» .
Нажмите «Импорт из URL» , введите имя для спецификации OpenAPI и в поле URL укажите путь к исходному содержимому спецификации OpenAPI на GitHub:

https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml
Нажмите «Выбрать» .

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

В мастере создания прокси отображается страница «Подробности». Поля предварительно заполнены значениями, определенными в спецификации OpenAPI, как показано на следующем рисунке.

Поле	Описание	По умолчанию
Имя прокси	Название API-прокси. Например: `Mock-Target-API` .	свойство `title` из спецификации OpenAPI, где пробелы заменены дефисами.
Базовый путь прокси	Компонент пути, который однозначно идентифицирует этот API-прокси в рамках организации. Общедоступный URL этого API-прокси состоит из названия вашей организации, среды, в которой развернут этот API-прокси, и этого базового пути. Например: `http://myorg-test.apigee.net/mock-target-api`	Содержимое поля «Имя» преобразовано в нижний регистр.
Существующий API	Целевой URL-адрес вызывается от имени этого API-прокси. Можно использовать любой URL-адрес, доступный в открытом интернете. Например: `http://mocktarget.apigee.net`	свойства `servers` из спецификации OpenAPI
Описание	Описание API-прокси.	свойство `description` из спецификации OpenAPI

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
...
servers:
  - url: http://mocktarget.apigee.net
  - url: https://mocktarget.apigee.net
...

Отредактируйте поле «Описание» следующим образом: API proxy for the Apigee mock target service endpoint.
Нажмите «Далее» .
На странице «Потоки» убедитесь, что выбраны все операции.
Совет: Условные потоки генерируются автоматически на основе операций, определенных в объекте paths в спецификации OpenAPI. Условные потоки сообщают Edge: «Когда вы видите это, выполните эту логику». Например, когда вызов API представляет собой GET-запрос к ресурсу /xml (условие), преобразуйте ответ в JSON (с помощью политики, прикрепленной к условному потоку). За одну транзакцию выполняется только один поток — первый поток, условие которого оценивается как истинное.
Нажмите «Далее» .
На странице «Безопасность» выберите параметр безопасности «Сквозная передача (нет)» и нажмите «Далее» .
На странице «Виртуальные хосты» убедитесь, что выбраны все виртуальные хосты, и нажмите «Далее» .
На странице «Сборка» убедитесь, что выбрана тестовая среда, и нажмите «Сборка и развертывание» .
На странице «Сводка» вы увидите подтверждение того, что ваш новый API-прокси был успешно создан и развернут в вашей тестовой среде.
Нажмите Mock-Target-API , чтобы отобразить страницу обзора прокси-сервера API.

Поздравляем! Вы создали API-прокси на основе спецификации OpenAPI. Далее вы протестируете его, чтобы посмотреть, как он работает.

Проверьте работу API-прокси.

Вы можете протестировать свой API Mock-Target-API используя cURL или веб-браузер.

В окне терминала выполните следующую команду cURL. Подставьте название вашей организации в URL-адрес.

curl http://<org_name>-test.apigee.net/mock-target-api

Ответ

Вы должны увидеть следующий ответ:

Hello, Guest!

Отлично! Вы создали простой API-прокси на основе спецификации OpenAPI и протестировали его.

Добавить политику XML в JSON

Далее вам нужно добавить политику преобразования XML в JSON в условный поток «Просмотр XML-ответа» , который был автоматически сгенерирован при создании API-прокси на основе спецификации OpenAPI. Эта политика преобразует XML-ответ целевого объекта в JSON-ответ.

Сначала вызовите API, чтобы сравнить результаты с результатами, полученными после добавления политики. В окне терминала выполните следующую команду cURL. Вы обращаетесь к ресурсу /xml целевой службы, который по умолчанию возвращает простой блок XML. Подставьте название вашей организации в URL.

curl http://<org_name>-test.apigee.net/mock-target-api/xml

Ответ

Вы должны увидеть следующий ответ:

<root> 
  <city>San Jose</city> 
  <firstName>John</firstName> 
  <lastName>Doe</lastName> 
  <state>CA</state> 
</root>

Теперь давайте сделаем что-нибудь, что преобразует XML-ответ в JSON. Добавьте политику преобразования XML в JSON в условный поток «Просмотр XML-ответа» в API-прокси.

В пользовательском интерфейсе Edge нажмите вкладку «Разработка» в правом верхнем углу страницы «Обзор Mock-Target-API».
В левой панели навигатора, в разделе «Конечные точки прокси» > «По умолчанию», щелкните условный поток «Просмотр XML-ответа» .
Нажмите кнопку «+Шаг» внизу, соответствующую варианту ответа для данного процесса.

Открывается диалоговое окно «Добавить шаг», в котором отображается отсортированный по категориям список всех политик, которые можно добавить.
Прокрутите страницу до категории «Медиация» и выберите «XML в JSON» .
Оставьте значения по умолчанию для полей «Отображаемое имя» и «Имя» .
Нажмите «Добавить» . К ответу будет применена политика преобразования XML в JSON.
Нажмите « Сохранить ».

Теперь, когда вы добавили политику, снова вызовите API с помощью cURL. Обратите внимание, что вы по-прежнему обращаетесь к тому же ресурсу /xml . Целевой сервис по-прежнему возвращает свой блок XML, но теперь политика в прокси-сервере API преобразует ответ в JSON. Выполните следующий вызов:

curl http://<org_name>-test.apigee.net/mock-target-api/xml

Обратите внимание, что XML-ответ преобразуется в JSON:

{"root":{"city":"San Jose","firstName":"John","lastName":"Doe","state":"CA"}}

Поздравляем! Вы успешно протестировали выполнение политики, добавленной в условный поток.