openapi
Customize the behavior and appearance of integrated API documentation. Requires an OpenAPI description.
Options
| Option | Type | Description |
|---|---|---|
| codeSamples | [Language object] | Configure the generated code samples in your API documentation. |
| corsProxyUrl | string | Specifies custom CORS proxy server. |
| downloadUrls | API description URL object | Set the URLs used to download the API description in JSON or YAML format. |
| events | object | Event hooks to get notified about various user events in API docs |
| feedback | Feedback object | Hide or customize the type of or text included in the feedback form that displays at the end of each endpoint. |
| generatedSamplesMaxDepth | number | Sets the number of levels to display in generated payload samples. |
| hideDownloadButtons | boolean | Toggle the appearance of a Download OpenAPI description section. |
| hideInfoMetadata | boolean | Toggle the appearance of OpenAPI info metadata sections. |
| hidePropertiesPrefix | boolean | Hides the parent name for nested properties. |
| hideReplay | boolean | Hides the Replay (Try it) functionality. |
| hideSchemaTitles | boolean | Hides the schema field title next to the type. |
| jsonSamplesExpandLevel | number | string | 'all' | Sets the default expand level for JSON payload samples. |
| layout | 'three-panel' | 'stacked' | Specifies layout options for OpenAPI documentation. |
| maxDisplayedEnumValues | number | Specifies number of enum values to display. |
| onlyRequiredInSamples | boolean | Displays only required fields in request samples. |
| sanitize | boolean | Sanitize HTML/Markdown to prevent cross-site scripting (XSS) attacks. |
| schemaDefinitionsTagName | string | Sets a schema definitions tag name that is applied to all schemas and displayed in the sidebar navigation. |
| schemasExpansionLevel | number | string | 'all' | Sets the default expand level for schemas. |
| showExtensions | string[] | boolean | Displays specification extensions ('x-' fields). |
| sortRequiredPropsFirst | boolean | Sorts schema properties to display required properties first. |
| feedback | object | Feedback options. |
Examples
Configure multiple APIs
In your config file, the openapi options can be defined in the root-level or per-API.
- Root-level options apply to all API descriptions.
- API-level options apply only to individual descriptions.
- If both are present, then the options are merged, but the per-API options take precedence.
The following example shows separate configurations for multiple APIs:
Redocly.yaml file
logo: images/awesome-logo.svg
openapi:
hideReplay: true
apis:
museum@default:
root: 'openapi/museum.yaml'
openapi:
downloadUrls:
- title: Download OpenApiDescription
url: 'https://github.com/Redocly/museum-openapi-example/blob/main/openapi.yaml'
hideReplay: false
codeSamples:
languages:
- lang: 'curl'
label: 'curl'
hideRequestPayloadSample: true
museum@test:
root: 'openapi/museum-test.yaml'
openapi:
hideDownloadButtons: true
hideReplay: true
codeSamples:
languages:
- lang: 'Node.js'
- lang: 'go'
rules:
example-rule-name: error