Расширение x-yc-apigateway-integration:swagger

Расширение Swagger UI позволяет пользователю получать интерактивную документацию, а также тестировать и отлаживать API в интерфейсе Swagger UI.

Добавить расширение в спецификацию можно с помощью конструктора спецификаций.

Спецификация расширенияСпецификация расширения

Пример спецификации:

openapi: "3.0.0"
info:
  version: 1.0.0
  title: Sample API
paths:
  /docs:
    get:
      x-yc-apigateway-integration:
        type: swagger

При добавлении ресурса /docs с интеграцией Swagger UI в OpenAPI-спецификацию пользователь получит доступ к интерфейсу Swagger UI по адресу /docs.

Авторизация и все политики доступа будут применены автоматически, так как /docs — это полноценный эндпоинт в рамках API Gateway.