echoserve 2.2.3

A mock HTTP API server with YAML config: static responses, response sequences, and simulated latency for testing
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

# echoserve

[![Build](https://github.com/ztroop/echoserve/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/ztroop/echoserve/actions/workflows/build.yml)

Echoserve is a mock API server that serves configurable responses based on a YAML configuration file. It supports static responses as well as response sequences for endpoints.

## Installation

```sh
cargo install echoserve
```

Or install from the git repository:

```sh
cargo install --git https://github.com/ztroop/echoserve echoserve
```

## Features
- Serve mock endpoints with configurable method, path, status, headers, and payload.
- Support for JSON, XML, HTML, and plain text responses.
- Sequence feature: endpoints can return a series of different responses in order.
- Simulated latency.

## Usage

```sh
echoserve --config examples/config.yml
```

Or run from source:

```sh
cargo run -- --config examples/config.yml
```

### Command-line Options
- `-c, --config <FILE>`: Path to the YAML configuration file.
- `-p, --port <PORT>`: Port to listen on (default: 8080).
- `-a, --address <ADDR>`: Address to bind to (default: 127.0.0.1).
- `-l, --latency <MS>`: Simulated latency in milliseconds (default: 0).

## Configuration File Format

The configuration file is a YAML file containing a list of endpoint definitions. Each endpoint can specify a static response or a sequence of responses.

**Validation:** Endpoint paths must start with `/`. Empty sequences are rejected.

### Static Response Example
```yaml
- name: "Example Endpoint 1"
  endpoint: "/example1"
  method: "GET"
  data:
    format: "xml"
    payload: |
      <example>
        <id>12345</id>
        <description>Data for the first example</description>
      </example>
  status: 200
  headers:
    Custom-Header: "Value1"
```

### Sequence Response Example
```yaml
- name: "Sequence Example"
  endpoint: "/sequence"
  method: "GET"
  sequence:
    - data:
        format: "json"
        payload:
          message: "First response"
      status: 200
    - data:
        format: "json"
        payload:
          message: "Second response"
      status: 200
    - data:
        format: "json"
        payload:
          message: "Final response"
      status: 404
```

- On each request to `/sequence`, the next response in the sequence is returned. After the last response, the final response is repeated for subsequent requests.

### Not Found Example
```yaml
- name: "Not Found Example"
  endpoint: "/notfound"
  status: 404
```