apis
Introduction
If your project contains multiple APIs, the apis
configuration section allows you to set up different rules and settings for different 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. |
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
Related options
- extends sets the base ruleset to use.
- rules settings define the linting rules that are used.
- decorators offer some transformations for your OpenAPI documents.
Resources
- More information and examples of per-API configuration.
- List of built-in rules.