Yandex Cloud
Search
Contact UsGet started
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • AI for business
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Yandex API Gateway
  • Getting started
    • Resource relationships
    • Networking
      • Overview
        • Static response
        • Access over HTTP
        • Cloud Functions
        • Serverless Containers
        • Smart Web Security
        • Object Storage
        • DataSphere
        • Data Streams
        • Message Queue
        • Managed Service for YDB
        • Swagger UI
      • Greedy parameters
      • Generic HTTP method
      • Authorization using a Cloud Functions function
      • Authorization using a JWT
      • WebSocket protocol support
      • Data validation
      • CORS
      • Specification parameterization
      • Canary release
      • Request rate limit
      • Response code replacement
      • Transformation of response and request bodies
    • Quotas and limits
  • Access management
  • Tools
  • Pricing policy
  • Terraform reference
  • Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes
  • FAQ
  1. Concepts
  2. Specification extensions
  3. Integration options
  4. Swagger UI

x-yc-apigateway-integration:swagger extension

Written by
Yandex Cloud
Updated at December 2, 2025

With Swagger UI, you can access interactive documents, test and debug your API from the Swagger UI interface.

You can add an extension to a specification using the specification constructor.

Extension specificationExtension specification

Specification example:

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

By adding the /docs resource with Swagger UI integration to the OpenAPI specification, you will get access to the Swagger UI interface at /docs.

The authorization and all access policies will apply automatically, because /docs is a full-blown endpoint under API Gateway.

Was the article helpful?

Previous
Managed Service for YDB
Next
Greedy parameters
© 2025 Direct Cursus Technology L.L.C.