echoserve

A mock server tool designed for testing API requests. It allows you to specify endpoints and their responses through a YAML configuration file or defaults to a simple echo server if no file is provided.

Features

• Flexible Endpoint Configuration: Define custom endpoints with associated JSON responses and status codes in a YAML file.
• Default Echo Mode: In the absence of a configuration file, it responds to all requests with a successful response.
• Simple and Lightweight: Easy to set up and use for quick API testing.
• Simulated Latency: Customize latency to simulate delayed responses.

Usage

Usage: echoserve [OPTIONS]

Options:
  -p <PORT>         Port number to listen on. (Default: 8080)
  -a <ADDRESS>      Address to listen on. (Default: 127.0.0.1)
  -c <CONFIG>       Optional path to a YAML configuration file.
  -l <LATENCY>      Simulated latency in milliseconds. (Default: 0)
  -h, --help        Print help
  -V, --version     Print version

Configuration

Each item in the list represents a configuration for an API endpoint. Each endpoint configuration consists of several key-value pairs that define its properties. Here's what each key represents:

Field	Default	Description
name	Required	A human-readable identifier for the endpoint. It's used for reference and doesn't affect the endpoint's functionality.
endpoint	Required	The URI path that the endpoint responds to. This is the part of the URL that follows your domain or base URL.
method	GET	Specifies the HTTP method (e.g., GET, POST) the endpoint should respond to. It defines the type of operation you want to perform.
status	200	The HTTP status code that the endpoint will return. It indicates the result of the request (e.g., 200 for success, 404 for not found).
headers	None	Specifies any additional HTTP headers that the response will include. Headers are often used for specifying the content type or for authentication.
data	None	Specifies the response data. It has two keys: format and payload.
data.format	json	Options: json, xml, html, and text.
data.payload	None	Specifies either a string literal or key-value pairs.

See EXAMPLES for a configuration sample.