Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex API Gateway
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Создание API-шлюза
    • Изменение API-шлюза и его спецификации
    • Подключение домена
    • Удаление API-шлюза
    • Просмотр графика мониторинга
    • Просмотр журнала выполнения
  • Сценарии использования
    • Развертывание веб-приложения
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Расширения спецификации
      • Обзор
      • Статический ответ
      • Вызов функции
      • Обращение по HTTP
      • Интеграция с Object Storage
      • Жадные параметры
      • Обобщенный HTTP-метод
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • ApiGatewayService
      • OperationService
    • REST
      • Обзор
      • ApiGateway
        • Обзор
        • create
        • delete
        • get
        • getOpenapiSpec
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
  • Вопросы и ответы
  1. Пошаговые инструкции
  2. Создание API-шлюза

Создание API-шлюза

    Консоль управления
    CLI
    1. В консоли управления выберите каталог, в котором необходимо создать API-шлюз.

    2. В списке сервисов выберите API Gateway.

    3. Нажмите кнопку Создать API-шлюз.

    4. В поле Имя введите numbers.

    5. (опционально) В поле Описание введите описание.

    6. В блок Спецификация добавьте спецификацию:

      openapi: "3.0.0"
      info:
        version: 1.0.0
        title: Test API
      paths:
        /hello:
          get:
            summary: Say hello
            operationId: hello
            parameters:
              - name: user
                in: query
                description: User name to appear in greetings
                required: false
                schema:
                  type: string
                  default: 'world'
            responses:
              '200':
                description: Greeting
                content:
                  'text/plain':
                     schema:
                       type: "string"
            x-yc-apigateway-integration:
              type: dummy
              http_code: 200
              http_headers:
                'Content-Type': "text/plain"
              content:
                'text/plain': "Hello, {user}!\n"
      
    7. Нажмите кнопку Создать.

    Чтобы создать API-шлюз:

    1. Сохраните следующую спецификацию в файл hello-world.yaml:

      openapi: "3.0.0"
      info:
        version: 1.0.0
        title: Test API
      paths:
        /hello:
          get:
            summary: Say hello
            operationId: hello
            parameters:
              - name: user
                in: query
                description: User name to appear in greetings
                required: false
                schema:
                  type: string
                  default: 'world'
            responses:
              '200':
                description: Greeting
                content:
                  'text/plain':
                     schema:
                       type: "string"
            x-yc-apigateway-integration:
              type: dummy
              http_code: 200
              http_headers:
                'Content-Type': "text/plain"
              content:
                'text/plain': "Hello, {user}!\n" 
      
    2. Выполните команду со следующими параметрами:

      • name — имя API-шлюза.
      • spec — файл со спецификацией.
      • description — описание API-шлюза.
      yc serverless api-gateway create --name hello-world --spec=hello-world.yaml --description "hello world"
      
      done (29s)
      id: d5dug9gkmu187iojcrtr
      folder_id: b1g55tflru0ek7omtfu0
      created_at: "2020-06-17T09:20:22.929Z"
      name: hello-world
      description: hello world
      status: ACTIVE
      domain: d5dug9gkmu187iojcpvp.apigw.yandexcloud.net
      log_group_id: ckghq1hm19q7ek5sjnh5
      
    Language / Region
    Вакансии
    Политика конфиденциальности
    Условия использования
    Брендбук
    © 2021 ООО «Яндекс.Облако»