Облачная платформаEvolution

Создание шлюза API из файла спецификации


Сценарий использования

Создать и настроить шлюз API на основе JSON- или YAML-спецификации.

Порядок действий
  1. Откройте рабочую область API Gateway: Разработка → API Gateway.

  2. Нажмите Создать API-шлюз на главной странице сервиса.

  3. Заполните поле Название шлюза.

  4. Перетащите YAML-файл или JSON-файл со спецификацией шлюза в OpenAPI.

    Пример файла:

    openapi: 3.0.0
    info:
    version: 1.0.0
    title: Test
    paths:
    /test-mock-1:
    get:
    operationId: getDemo1
    x-cloud-mock:
    $ref: "#/components/x-cloud-mocks/GetMock"
    /test-mock-2:
    get:
    operationId: getDemo2
    x-cloud-mock:
    $ref: "#/components/x-cloud-mocks/GetMock"
    components:
    x-cloud-mocks:
    GetMock:
    content_type: "application/json"
    delay: 1
    response_status: 200
    response_example: '{"status": "Success GET"}'
  5. Нажмите Создать.

Шлюз будет создан автоматически на основе спецификации.

Подсказка

При загрузке спецификации, указанной выше, будет создан шлюз с двумя правилами типа Mock API. Оба правила имеют одинаковые параметры, описанные в секции components.

Адрес шлюза назначается автоматически при создании и недоступен для редактирования.

Спецификация содержит расширения, которые начинаются с префикса x-cloud. Разные расширения x-cloud-<название расширения> могут объявляться на разных уровнях спецификации (root, path, operation).

С помощью расширений можно определить:

  • правила

  • подключения

  • плагины

  • тип авторизации