include

Version

Includes additional YAML configuration files. Each include: is expanded in-place at that position, so the proxy/API registration order matches the document order in the file.

Include entries are resolved in the order they are listed. If an entry points to a directory, all matching *.apis.yaml / *.apis.yml files in that directory are included in lexicographical order. Includes are resolved recursively and cyclic include chains are rejected. Directory includes are not watched for YAML hot deployment; adding or removing files there does not trigger a reload automatically.

Multiple include: documents may appear at different positions to control routing priority: included APIs listed earlier take priority over those listed later, and their position relative to inline APIs in the same file is preserved.

Example Configuration

include:
- ./apis/high-priority.apis.yaml
---
api:
port: 8080
---
include:
- ./apis/low-priority.apis.yaml
include:
   - ./apis/high-priority.apis.yaml
 ---
 api:
   port: 8080
 ---
 include:
   - ./apis/low-priority.apis.yaml

Syntax

include:
- <string>
include:
  - <string>

Can be used in

No parent elements.