plugins

Introduction

Redocly supports custom plugins for extending lint and decorator behavior. Use plugins when you need to add rules beyond the built-in and configurable, or decorators beyond the built-in decorators.

Options

The plugins configuration is an array of paths to plugin files, relative to the config file. You can include as many plugins as you need.

Examples

A basic example of including two plugins from a directory named plugins/ is shown in the example below:

plugins:
  - plugins/my-best-plugin.js
  - plugins/another-plugin.js

Remember that you need to include plugins in the plugins section before you can use the content of the plugin elsewhere in the configuration file.

Related options

• apis configuration options allow setting per-API configuration in redocly.yaml.
• rules settings define the linting rules that are used.
• decorators offer some transformations for your OpenAPI documents.

Resources

• The Redocly CLI cookbook has many examples of plugins.
• Read more configuration examples.