ReDoc makes use of the following vendor extensions
Extends OpenAPI Info Object
Field Name | Type | Description |
---|---|---|
x-logo | Logo Object | The information about API logo |
x-logo
is used to specify API logo. The corresponding image are displayed just above side-menu.
The information about API logo
Field Name | Type | Description |
---|---|---|
url | string | The URL pointing to the spec logo. MUST be in the format of a URL |
backgroundColor | string | background color to be used. MUST be RGB color in [hexadecimal format] (https://en.wikipedia.org/wiki/Web_colors#Hex_triplet) |
json
{
"info": {
"version": "1.0.0",
"title": "Swagger Petstore",
"x-logo": {
"url": "https://rebilly.github.io/ReDoc/petstore-logo.png",
"backgroundColor": "#FFFFFF"
}
}
}
yaml
info:
version: "1.0.0"
title: "Swagger Petstore"
x-logo:
url: "https://rebilly.github.io/ReDoc/petstore-logo.png"
backgroundColor: "#FFFFFF"
Extends OpenAPI Tag Object
Field Name | Type | Description |
---|---|---|
x-traitTag | boolean | In Swagger two operations can have multiply tags. This property distinguish between tags that are used to group operations (default) from tags that are used to mark operation with certain trait (true value) |
Field Name | Type | Description |
---|---|---|
x-displayName | string | Define the text that is used for this tag in the menu and in section headings |
Tags that have x-traitTag
set to true
are listed in side-menu but don't have any subitems (operations). Tag description
is rendered as well.
This is useful for handling out common things like Pagination, Rate-Limits, etc.
json
{
"name": "Pagination",
"description": "Pagination description (can use markdown syntax)",
"x-traitTag": true
}
yaml
name: Pagination
description: Pagination description (can use markdown syntax)
x-traitTag: true
Extends OpenAPI Operation Object
Field Name | Type | Description |
---|---|---|
x-code-samples | [ Code Sample Object ] | A list of code samples associated with operation |
x-code-samples
are rendered on the right panel of ReDoc
Operation code sample
Field Name | Type | Description |
---|---|---|
lang | string | Code sample language. Value should be one of the following list |
source | string | Code sample source code |
json
{
"lang": "JavaScript",
"source": "console.log('Hello World');"
}
yaml
lang: JavaScript
source: console.log('Hello World');
Extends OpenAPI Schema Object
Field Name | Type | Description |
---|---|---|
x-nullable | boolean | marks schema as a nullable |
Schemas marked as x-nullable
are marked in ReDoc with the label Nullable