Datasources
APICHAP is designed to work with multiple datasources, including databases and 3rd party APIs. This means that you can configure your software to interact with a wide range of datasources and services.
Type | Information |
---|---|
Database | Connect to a SQL database. |
REST-API (JSON) | Send and retrieve data via request to a 3rd party |
Roadmap: We are constantly expanding the list of supported datasources and are happy to prioritize future integrations with your feedback.
In order to identify multiple datasources, you will need to specify a name for each one. This name will allow you to easily reference the datasource throughout your configuration files.
DATABASES
APICHAP currently supports the following databases:
- mariadb
- postgres
- MSSQL
Roadmap: We are constantly expanding the list of supported datasources and are happy to prioritize future integrations with your feedback.
Field | Description | |
---|---|---|
type | Specifies the type of datasource. Use the value "db" for database. | Mandatory |
url | The URL or endpoint for the datasource. In this case, the URL is "jdbc:mariadb://host.docker.internal:3306/sample-products". | Mandatory for "db" |
user | The username for the datasource. | Optional, user can also be part of the url |
password | The password for the datasource. | Optional, password can also be part of the url |
An example datasource for a mariadb database called 'demodb':
datasources:
demodb:
type: db
url: jdbc:mariadb://host.docker.internal:3306/sample-products
user: testuser
password: samplepwd
REST-API (JSON)
Specifying a REST-API as a datasource is fairly easy by only setting the type.