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 |
Enabling Swagger UI
Swagger UI is disabled by default. To enable it, set SwaggerEnabled: true in the API Proxies configuration:
ApiProxies__0__SwaggerEnabled: true
API proxies configured with an API Key are supported by Swagger UI. When users authorize in Swagger UI using an API key, they can use the Try it out feature to execute API calls directly from Swagger UI. This enables interactive testing of the API endpoints while ensuring that only authorized users can perform such actions.
Enabling Swagger UI Try It Out
Swagger UI Try it out is disabled by default. To enable it, set SwaggerTryItOutEnabled: true in the API Proxies configuration:
ApiProxies__0__SwaggerTryItOutEnabled: true
See API Proxies for the full list of configuration options.