HTTP stub server from plain files

Liège is a static file server for tests with some special features to easily setup a stub server without requiring too much configuration:

• Handle all HTTP methods (static file servers usually handle GET/HEAD methods only)
• Allow customizing request routing and response using the file name without requiring a configuration file
• Send the request body back in an HTTP header
• Handle index files

liege [flags] <root-dir>

$ liege ./data/
_________ __   _________________
________ / /  /  _/ __/ ___/ __/
_______ / /___/ // _// (_ / _/
______ /____/___/___/\___/___/

HTTP server started on port 3000

Given the following file tree:

data/ -> server root directory
 |-- items/
 |    |-- index.json
 |    |-- index__qs.json
 |    |-- 1__GET.json
 |-- admin/
 |    |-- index__403_l50 (empty file)

The server will handle the following routes:

And send the following response with an optional additional latency:

• Status code: 200 (default) or a custom code
• Headers:
  • Content-Type: determined from file content and extension, e.g. application/json; charset=utf-8
  • X-Request-Body: base64 encoded request body (only if body size <= 4 KB)
• Body: stub file contents

Routing and response can be customized using the following file name syntax:

<path>[__<options>][.<ext>]

__<options> can be used to further customize request routing and response by appending a list of options, prefixed by __ and separated by _, at the end of the file name:

For example, the content of a file named page__GET_qsearch_403_l250 will be sent with a 403 status code and at least 250 ms latency only for GET requests on /page URL with a search query parameter.

The latency can be constant (<x>) or random between a range (<x>-<y>) and can be defined globally (using the CLI or the environment variable) and at the route level using the file name. The same syntax (<x>[-<y>]) is used in both cases. Latency defined at the file level overrides globally defined latency unless the latter is set to -1 which totally disables latency.

On start-up, the server loads stub files in memory and build routes. To reload stub files from the root directory and update routes, call the refresh endpoint.

The server provides the following management endpoints:

Generate a self-signed X.509 TLS certificate or obtain a certificate from a CA, and start the server with -c and -k flags:

$ liege -c cert.pem -k key.pem ./data/

Liège is licensed under the GNU General Public License.