rest

HTTP REST API

Configuration loading is designed for containerization in mind. The container engine and orchestrator can mount volumes (secret or regular) as well as set the environment variables as outlined below.

You may set configurations through both files and environment variables. Please note that environment variables will override the settings in the configuration files. The configuration files are all expected to be in YAML format.

Table of contents

• File Location(s)
• Configuration File
  • Example Configuration File
  • Example Environment Variables
• Swagger UI

File Location(s)

The configuration loader will search for the configurations in the following order:

Location	Details
/etc/MCQPlatform.conf/	The etc directory is the canonical location for configurations.
$HOME/.MCQPlatform/	Configurations can be located in the user's home directory.
./configs/	The config folder in the root directory where the application is located.
Environment variables	Finally, the configurations will be loaded from environment variables and override configuration files

Configuration File

The expected file name is HTTPRESTConfig.yaml. All the configuration items below are required.

Name	Environment Variable Key	Type	Description
Server	REST_SERVER		Parent key for server configurations.
↳ port_number	↳ .PORT_NUMBER	int	Service port for inbound and outbound connections.
↳ shutdown_delay	↳ .SHUTDOWN_DELAY	int	The number of seconds to wait after a shutdown signal is received to terminate the server.
↳ base_path	↳ .BASE_PATH	string	The service endpoints base path.
↳ swagger_path	↳ .SWAGGER_PATH	string	The path through which the Swagger UI will be accessible.
Authorization	REST_AUTHORIZATION		Parent key for authentication configurations.
↳ header_key	↳ .HEADER_KEY	string	The HTTP header key where the authorization token is stored.

Example Configuration File

server:
  port_number: 44243
  shutdown_delay: 5
  base_path: api/rest/v1
  swagger_path: /swagger/*any

Example Environment Variables

export REST_SERVER.PORT_NUMBER=44243
export REST_SERVER.BASE_PATH=api/rest/v1

Swagger UI

The Swagger UI is accessible through the endpoint URL that is provided in the configurations to view the REST schemas as well as issue test requests to the endpoints.