apimock 5.0.0

HTTP(S) mock server. Drop JSON files into a folder and your API immediately exists.
Documentation 
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

# Rule-based routing

## Defining Rules

Now, let's dive into `apimock-rule-set.toml` and define some powerful rules ! Each rule checks incoming requests against specific conditions (like URL path, headers, or body content) and, if they match, sends a predefined response.

Here are examples of how you can set up different types of rules in `apimock-rule-set.toml`:

### Example 1: Match with Request URL Path

These examples show how to define responses based on the incoming request's URL path.

```toml
# apimock-rule-set.toml
[[rules]]
when.request.url_path = ""
respond = { text = "I'm at root." }
```

```toml
# apimock-rule-set.toml
[[rules]]
when.request.url_path = "home"
# Make sure to create `home.json` in a JSON format!
respond.file_path = "home.json"
```

**Test:**

```sh
curl http://localhost:3001/
# I'm at root.

curl http://localhost:3001/home
# (home.json content)
```