mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-09 12:47:48 +00:00
17b73c1723
* docs: Add resolve config reference * docs: Start API reference, needs child config entries * docs: Add sidebar entries for config reference pages * docs: Add rules and decorators config pages * docs: Fix links and format * docs: Fix links and formatting * docs: Add extends and plugins config reference pages * docs: Add a basic preprocessor page * docs: Update from review feedback * Apply suggestions from code review Co-authored-by: Heather Cloward <heathercloward@gmail.com> * docs: Reformat required labels * Apply suggestions from code review Co-authored-by: Heather Cloward <heathercloward@gmail.com> * docs: Fix misspelling --------- Co-authored-by: Heather Cloward <heathercloward@gmail.com>
86 lines
1.7 KiB
Markdown
86 lines
1.7 KiB
Markdown
# `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
|
|
|
|
{% table %}
|
|
|
|
- Option
|
|
- Type
|
|
- Description
|
|
|
|
---
|
|
|
|
- `{name}@{version}`
|
|
- [API object](#api-object)
|
|
- **REQUIRED**. Each API needs a name and optionally a version. Supports alphanumeric characters and underscores.
|
|
|
|
{% /table %}
|
|
|
|
### API object
|
|
|
|
{% table %}
|
|
|
|
- Option
|
|
- Type
|
|
- Description
|
|
|
|
---
|
|
|
|
- root
|
|
- string
|
|
- **REQUIRED**. Path to the root API description file.
|
|
|
|
---
|
|
|
|
- rules
|
|
- [Rules object](./rules.md)
|
|
- Additional rule configuration for this API.
|
|
|
|
---
|
|
|
|
- decorators
|
|
- [Decorators object](./decorators.md)
|
|
- Additional decorator configuration for this API.
|
|
|
|
---
|
|
|
|
- preprocessors
|
|
- [Decorators object](./decorators.md)
|
|
- Preprocessors run before linting, and follow the same structure as decorators. We recommend the use of decorators over preprocessors in most cases.
|
|
|
|
{% /table %}
|
|
|
|
## Examples
|
|
|
|
The following example shows a simple `redocly.yaml` configuration file with settings for multiple APIs.
|
|
|
|
```yaml
|
|
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](./extends.md) sets the base ruleset to use.
|
|
- [rules](./rules.md) settings define the linting rules that are used.
|
|
- [decorators](./decorators.md) offer some transformations for your OpenAPI documents.
|
|
|
|
## Resources
|
|
|
|
- More information and examples of [per-API configuration](../apis.md).
|
|
- List of [built-in rules](../../rules/built-in-rules.md).
|