`apis`

Introduction

If your project contains multiple APIs, you can use the apis configuration section to set up rules and settings for individual APIs.

Options

Option	Type	Description
`{name}@{version}`	API object	REQUIRED. Each API needs a name and optionally a version. Supports alphanumeric characters and underscores.

API object

Option	Type	Description
root	string	REQUIRED. Path to the root API description file.
rules	Rules object	Additional rule configuration for this API.
decorators	Decorators object	Additional decorator configuration for this API.
preprocessors	Decorators object	Preprocessors run before linting, and follow the same structure as decorators. We recommend the use of decorators over preprocessors in most cases.
output	Output file path	When running `bundle` without specifying an API, the bundled API description is saved to this location.

Examples

The following example shows a simple redocly.yaml configuration file with settings for multiple APIs.

apis:
  orders@v3:
    root: orders/openapi.yaml
    rules:
      tags-alphabetical: error
      operation-operationId-unique: error
      spec-strict-refs: error
  newsletter:
    root: newsletter/openapi.yaml
    rules:
      info-contact: off
      operation-summary: off

The following example shows redocly.yaml configuration file with settings for multiple APIs outputs.

apis:
  main@v1:
    root: openapi-v1.yaml
    output: v1/bundled.yaml
  main@v2:
    root: openapi-v2.yaml
    output: v2/bundled.yaml

When running redocly bundle with this config, the bundled API descriptions are saved to the corresponding location.

Resources

extends sets the base ruleset to use.
rules settings define the linting rules that are used.
decorators offer some transformations for your OpenAPI documents.
More information and examples of per-API configuration.
Explore other configuration options for your project.

apis