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

Метод getOpenapiSpec

  • HTTP-запрос
  • Path-параметры
  • Query-параметры
  • Ответ

Возвращает спецификацию OpenAPI указанного API-шлюза.

HTTP-запрос

GET https://serverless-apigateway.api.cloud.yandex.net/apigateways/v1/apigateways/{apiGatewayId}:spec

Path-параметры

Параметр Описание
apiGatewayId Обязательное поле. Идентификатор API-шлюза для получения спецификации.

Query-параметры

Параметр Описание
format Формат возвращаемой спецификации. По умолчанию используется исходный формат, используемый в CreateApiGatewayRequest.

Ответ

HTTP Code: 200 - OK

{
  "apiGatewayId": "string",
  "openapiSpec": "string"
}
Поле Описание
apiGatewayId string

Идентификатор API-шлюза.

openapiSpec string

Текст спецификации, JSON или YAML.

В этой статье:
  • HTTP-запрос
  • Path-параметры
  • Query-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»