Swagger UI

When SwaggerEnabled is set to true for an API Proxy, Link exposes a Swagger UI endpoint that renders the OpenAPI Specification (OAS) file associated with that proxy. This provides a human-readable view of the API schema—including available endpoints, request parameters, and response structures—directly in the browser.

The following endpoints become available for the proxy at its configured Path:

Endpoint	Description
/{Path}/swagger	Swagger UI — renders the API schema in a browser-friendly interface
/{Path}/swagger.json	OpenAPI Specification — the raw OAS JSON document
/{Path}/swagger.yaml	OpenAPI Specification — the raw OAS YAML document

warning

APIs configured with an API Key are not supported by the Swagger UI.

Enabling Swagger UI

Swagger UI is disabled by default. To enable it, set SwaggerEnabled: true in the API Proxies configuration:

ApiProxies__0__SwaggerEnabled: true

See API Proxies for the full list of configuration options.