General
Configuration File
You are able to configure your APICHAMP instance by using a yaml configuration file. Full configuration examples are available in our Samples.
Filename
The configuration file must be named config.yaml and mounted under /app/config.yaml within your APICHAMP docker
image. How to launch APICHAMP.
Config Specification Versioning
The APICHAMP configuration files are versioned using a numeric value to indicate the syntax version. The version information is defined at the very top of the configuration file under the field specification.
Changelog
| Version | Description |
|---|---|
| 1.0 | Initial release of APICHAMP configuration |
Please note that as APICHAMP evolves, future versions may introduce additional features or syntax changes. Check our Release Notes for more information.
Structure
The APICHAMP configuration file comes in yaml format and contains the following sections.
| Section | Description |
|---|---|
| Operations | Each endpoint from your openAPI yaml configuration can be configured by creating an operation. In each operation you are able to define how your endpoint will process, map and return data. |
| Datasources | APICHAMP works with many datasources such as your database´s or a 3rd party API. Each datasource specified is usable in your fulfillments. |
| Authentications | Specifies your authentifications and security for your endpoints. |
| Settings | Specify global settings like for example debug mode or your licence. |
Methods & Data Processing
APICHAMP features a specialized syntax tailored for data processing and manipulation. Possible with the APICHAMP core functionality of methods, placeholders and conditions to facilitate smooth data access, filtering, and transformation tasks.