SXAPI configuration user guide
You have 3 ways to configure an sxapi instance. - With a configuration file (sxapi.yml) - With a configuration environement ($SXAPI_CONF)
Configuration file (sxapi.yml)
You can create a sxapi.yml file located on the path defined by the environment $APP_PATH.
Your configuration file must be a valid sxapi configuration file like,
sxapi configuration example
Configuration environement (SXAPI_CONF)
You can create an environment variable named SXAPI_CONF in you application platefrom.
Your environement variable should be a valid sxapi configuration file, like
sxapi configuration example
Sxapi description example
Static homepage example
This is a simple sxapi description for a single static webpage
name: sample-api
description: sample api using sxapi-core framework for a single homepage
version: 0.0.0
debug: true
resources:
serviceinfo-id:
_class: serviceinfo
server:
endpoints:
- path: "/"
body: "<html><head></head><body><h1>My API</h1></body></html>"
Application information example
This is a simple sxapi description for dynamic information about the running application.
name: sample-api
description: my sample api using sxapi-core framework for dynamic information about the running application.
version: 0.0.0
debug: true
resources:
serviceinfo-id:
_class: serviceinfo
server:
endpoints:
- path: "/"
resource: serviceinfo-id
endpoint: info
- path: "/health"
resource: serviceinfo-id
endpoint: health
- path: "/env"
resource: serviceinfo-id
endpoint: getEnv