Oscar's Projects

An interactive documentation built from an OpenAPI specification

Swagger UI

If set to true, enables deep linking for tags and operations which will add fragments in the URL which will link to the specific parts

The default expansion depth for models (set to -1 completely hide the models)

The default expansion depth for the model on the model-example section

Either "example" or "model", controls how the model is shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links)

Controls the display of operationId in operations list

Controls the display of the request duration (in milliseconds) for "Try it out" requests

Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing)

Either "true", "false" or a string. If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag

If set to true, it persists authorization data and it would not be lost on browser close/refresh

Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters

Controls the display of vendor extension (x-) fields and values for Operations, Parameters, Responses, and Schema

List of HTTP methods that have the "Try it out" feature enabled. An empty array disables "Try it out" for all operations. This does not filter the operations from the display

Either "true" or "false", controls whether the "Try it out" section should be enabled by default

The public URL pointing to API definition (normally swagger.json or swagger.yaml)