Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-10 19:06:34 +03:00
Code Issues Packages Projects Releases Wiki Activity
8c04c02ab0
redoc/docs/config.md
Adam Altman 8c04c02ab0
docs: fix admonition on config page (#2452)
2023-11-13 10:16:32 +00:00

11 KiB
Raw Blame History

Configure Redoc

Getting your documentation just right is important, and Redoc comes with many configuration options to help you succeed in that mission.

Each deployment type has documentation on how to configure options for that type of Redoc project. This page lists all the options you can use with Redoc.

Versions: 2.x

{% admonition type="success" name="Client-side configuration" %}

Using Redoc as a standalone (HTML or React) tool, these options must be presented in kebab case. For example, scrollYOffset becomes scroll-y-offset, and expandResponses becomes expand-responses.

{% /admonition %}

Functional settings

disableSearch

Disables search indexing and hides the search box from the API documentation page.

minCharacterLengthToInitSearch

Sets the minimum amount of characters that need to be typed into the search dialog to initiate the search.

Default: 3

expandDefaultServerVariables

Enables or disables expanding default server variables.

expandResponses

Controls which responses to expand by default. Specify one or more responses by providing their response codes as a comma-separated list without spaces, for example expandResponses='200,201'. Special value 'all' expands all responses by default. Be careful: this option can slow down documentation rendering time.

expandSingleSchemaField

Automatically expands the single field in a schema.

hideDownloadButton

Hides the 'Download' button for saving the API definition source file. This setting does not make the API definition private; it just hides the button.

hideHostname

If set to true, the protocol and hostname are not shown in the operation definition.

hideLoading

Hides the loading animation. Does not apply to CLI or Workflows-rendered docs.

hideRequestPayloadSample

Hides request payload examples.

hideOneOfDescription

If set to true, the description for oneOf/anyOf object is not shown in the schema.

hideSchemaPattern

If set to true, the pattern is not shown in the schema.

hideSchemaTitles

Hides the schema title next to to the type.

hideSecuritySection

Hides the Security panel section.

hideSingleRequestSampleTab

Hides the request sample tab for requests with only one sample.

htmlTemplate

Sets the path to the optional HTML file used to modify the layout of the reference docs page.

jsonSampleExpandLevel

Sets the default expand level for JSON payload samples (response and request body). The default value is 2, and the maximum supported value is '+Infinity'. It can also be configured as a string with the special value all that expands all levels.

Default: 2

maxDisplayedEnumValues

Displays only the specified number of enum values. The remaining values are hidden in an expandable area. If not set, all values are displayed.

menuToggle

If set to true, selecting an expanded item in the sidebar twice collapses it.

Default: true

nativeScrollbars

If set to true, the sidebar uses the native scrollbar instead of perfect-scroll. This setting is a scrolling performance optimization for big API definitions.

onlyRequiredInSamples

Shows only required fields in request samples.

pathInMiddlePanel

Shows the path link and HTTP verb in the middle panel instead of the right panel.

payloadSampleIdx

If set, the payload sample is inserted at the specified index. If there are N payload samples and the value configured here is bigger than N, the payload sample is inserted last. Indexes start from 0.

requiredPropsFirst

Shows required properties in schemas first, ordered in the same order as in the required array.

schemaExpansionLevel

Specifies whether to automatically expand schemas in Reference docs. Set it to all to expand all schemas regardless of their level, or set it to a number to expand schemas up to the specified level. For example, schemaExpansionLevel: 3 expands schemas up to three levels deep. The default value is 0, meaning no schemas are expanded automatically.

scrollYOffset

Specifies a vertical scroll-offset. This setting is useful when there are fixed positioned elements at the top of the page, such as navbars, headers, etc.

Note that you can specify the scrollYOffset value in any of the following ways:

  • as a number - a fixed number of pixels to be used as the offset.
  • as a CSS selector - the selector of the element to be used for specifying the offset. The distance from the top of the page to the element's bottom is used as the offset.
  • a function (advanced) - a getter function. Must return a number representing the offset (in pixels).

showExtensions

Shows specification extensions ('x-' fields). Extensions used by Redoc are ignored. The value can be boolean or an array of strings with names of extensions to display. When used as boolean and set to true, all specification extensions are shown.

showObjectSchemaExamples

Shows object schema example in the properties; default false.

showWebhookVerb

When set to true, shows the HTTP request method for webhooks in operations and in the sidebar.

simpleOneOfTypeLabel

Shows only unique oneOf types in the label without titles.

sortEnumValuesAlphabetically

When set to true, sorts all enum values in all schemas alphabetically.

sortOperationsAlphabetically

When set to true, sorts operations in the navigation sidebar and in the middle panel alphabetically.

sortPropsAlphabetically

When set to true, sorts properties in all schemas alphabetically.

sortTagsAlphabetically

When set to true, sorts tags in the navigation sidebar and in the middle panel alphabetically. Note that only tags are sorted alphabetically in the middle panel, not the operations associated with each tag. To sort operations alphabetically as well, you must set the sortOperationsAlphabetically setting to true.

Default: false

untrustedDefinition

If set to true, the API definition is considered untrusted and all HTML/Markdown is sanitized to prevent XSS.

Theme settings

  • spacing
    • unit: 5 # main spacing unit used in autocomputed theme values later
    • sectionHorizontal: 40 # Horizontal section padding. COMPUTED: spacing.unit * 8
    • sectionVertical: 40 # Horizontal section padding. COMPUTED: spacing.unit * 8
  • breakpoints # breakpoints for switching three/two and mobile view layouts
    • small: '50rem'
    • medium: '85rem'
    • large: '105rem'
  • colors
    • tonalOffset: 0.3 # default tonal offset used in computations
  • typography
    • fontSize: '14px'
    • lineHeight: '1.5em'
    • fontWeightRegular: '400'
    • fontWeightBold: '600'
    • fontWeightLight: '300'
    • fontFamily: 'Roboto, sans-serif'
    • smoothing: 'antialiased'
    • optimizeSpeed: true
    • headings
      • fontFamily: 'Montserrat, sans-serif'
      • fontWeight: '400'
      • lineHeight: '1.6em'
    • code # inline code styling
      • fontSize: '13px'
      • fontFamily: 'Courier, monospace'
      • lineHeight: # COMPUTED: typography.lineHeight
      • fontWeight: # COMPUTED: typography.fontWeightRegular
      • color: '#e53935'
      • backgroundColor: 'rgba(38, 50, 56, 0.05)'
      • wrap: false # whether to break word for inline blocks (otherwise they can overflow)
    • links
      • color: # COMPUTED: colors.primary.main
      • visited: # COMPUTED: typography.links.color
      • hover: # COMPUTED: lighten(0.2 typography.links.color)
      • textDecoration: 'auto'
      • hoverTextDecoration: 'auto'
  • sidebar
    • width: '260px'
    • backgroundColor: '#fafafa'
    • textColor: '#333333'
    • activeTextColor: # COMPUTED: theme.sidebar.textColor (if set by user) or theme.colors.primary.main
    • groupItems # Group headings
      • activeBackgroundColor: # COMPUTED: theme.sidebar.backgroundColor
      • activeTextColor: # COMPUTED: theme.sidebar.activeTextColor
      • textTransform: 'uppercase'
    • level1Items # Level 1 items like tags or section 1st level items
      • activeBackgroundColor: # COMPUTED: theme.sidebar.backgroundColor
      • activeTextColor: # COMPUTED: theme.sidebar.activeTextColor
      • textTransform: 'none'
    • arrow # sidebar arrow
      • size: '1.5em'
      • color: # COMPUTED: theme.sidebar.textColor
  • logo
    • maxHeight: # COMPUTED: sidebar.width
    • maxWidth: # COMPUTED: sidebar.width
    • gutter: '2px' # logo image padding
  • rightPanel
    • backgroundColor: '#263238'
    • width: '40%'
    • textColor: '#ffffff'
    • servers
      • overlay
        • backgroundColor: '#fafafa'
        • textColor: '#263238'
      • url
        • backgroundColor: '#fff'
  • fab
    • backgroundColor: '#263238'
    • color: '#ffffff'

Additional customization

Security Definition location

You can inject the Security Definitions widget into any place in your definition description. For more information, refer to Security definitions injection.

OpenAPI specification extensions

Redoc uses the following specification extensions:

  • x-logo - is used to specify API logo
  • x-traitTag - useful for handling out common things like Pagination, Rate-Limits, etc
  • x-codeSamples - specify operation code samples
  • x-examples - specify JSON example for requests
  • x-nullable - mark schema param as a nullable
  • x-displayName - specify human-friendly names for the menu categories
  • x-tagGroups - group tags by categories in the side menu
  • x-servers - ability to specify different servers for API (backported from OpenAPI 3.0)
  • x-ignoredHeaderParameters - ability to specify header parameter names to ignore
  • x-additionalPropertiesName - ability to supply a descriptive name for the additional property keys
  • x-summary - For Response object, use as the response button text, with description rendered under the button
  • x-extendedDiscriminator - In Schemas, uses this to solve name-clash issues with the standard discriminator
  • x-explicitMappingOnly - In Schemas, display a more descriptive property name in objects with additionalProperties when viewing the property list with an object