List of HTTP methods that have the "Try it out" feature enabled. If set to true, uses the mutated request returned from a requestInterceptor to produce the curl command in the UI, otherwise the request before the requestInterceptor was applied is used.Īrray=. Accepts one argument responseInterceptor(response) and must return the modified response, or a Promise that resolves to the modified response.īoolean=true. Function to intercept remote definition, "Try it out", and OAuth 2.0 responses. For example request.curlOptions = įunction=(a => a). This can be set on the mutated request in the requestInterceptor function. If set, MUST be an array of command line options available to the curl command. Accepts one argument requestInterceptor(request) and must return the modified request, or a Promise that resolves to the modified request.Īrray. Function to intercept remote definition, "Try it out", and OAuth 2.0 requests. This is the default configuration section for the theįunction=(a => a). When disabled, the legacy curl snippet will be used. Controls whether the "Try it out"īoolean=false. (Only these 6 styles are available.)īoolean=false. Payloads and cURL command, can be otherwise an object with theīoolean=true. Set to false to deactivate syntax highlighting of Swagger UI has finished rendering a newly provided definition. This parameter is Deprecated and will beįunction=NOOP.
When enabled, sanitizer will leaveĪttributes untouched on all HTML Elements declared inside markdown Default is the order determined by Swagger UI.īoolean=false.
Short menu rebrandly api configuration how to#
It can be 'alpha' (sort by paths alphanumerically) or aįunction (see () to learn how to Controls the display of extensionsįunction=(a => a). ( x-) fields and values for Operations, Parameters,īoolean=false. The order returned by the server unchanged.īoolean=false. It can be 'alpha' (sort by pathsĪlphanumerically), 'method' (sort by HTTP method) or a function (seeĪ() to know how sort function works). The default is to show allįunction=(a => a). If set, limits the number of tagged operationsĭisplayed to at most this many. Filtering is case sensitive matching theįilter expression anywhere inside the tag. String, in which case filtering will be enabled using that string as Can be Boolean to enable or disable, or a Top bar will show an edit box that you can use to filter the tagged (expands only the tags), 'full' (expands the tags and operations) orīoolean=false OR String. Controls the defaultĮxpansion setting for the operations and tags. Controls the display of the requestĭuration (in milliseconds) for "Try it out" requests. The rendering for a given model by clicking the 'Model' and 'Exampleīoolean=false. The default expansion depth for the model on The default expansion depth for models (set legacy (default) : last plugin takes precedence over the others - chain : chain wrapComponents when targeting the same core component, allowing multiple plugins to wrap the same componentĭeep linking for tags and operations. Control behavior of plugins when targeting the same component with wrapComponent. Usually, you'll want to include ApisPreset if you use this option. An array of presets to use in Swagger UI. An array of plugin functions to use in Swagger UI.Īrray=. A Javascript object to configure plugin integration and behaviors (see below).Īrray=. The name of a component available via the plugin system to use as the top-level layout for Swagger UI. Read more about the plugin system in the Customization documentation. Enables overriding configuration parameters via URL search params. If the value matches the name of a spec provided in urls, that spec will be displayed when Swagger UI loads, instead of defaulting to the first spec in urls.īoolean=false. When using urls, you can use this subparameter. Names and URLs must be unique among all items in this array, since they're used as identifiers. When used and Topbar plugin is enabled, the url parameter will not be parsed.
Swagger UI accepts configuration parameters in four locations.
0 kommentar(er)
