mocked
Your friendly HTTP mock response server.
Why?
mocked supports you when developing software. Here are a few reasons:
mocked allows you to include responses from external files, that might change during the development process. You
don't need to update your mocked config in these cases.- it allows developers to isolate the system under test from external dependencies. This is particularly useful when
testing components that interact with external services. By using
mocked, developers can simulate the behavior of the
external service and ensure that the system under test behaves as expected.
- when multiple teams are working on different components that need to interact with each other,
mocked can be used to
simulate the services that are still under development. This allows teams to work in parallel without having to wait
for each other.
- with
mocked, developers have full control over the responses from the server. This makes it possible to test how the
system behaves under different responses and in scenarios that might be difficult to reproduce with a real server.
mocked is configured using a config file in YAML format.
Example
options:
address: localhost
port: 15001
enable_cors: true
min_response_delay_ms: 100
max_response_delay_ms: 3000
routes:
- path: /v1/login
enable_cors: false
methods:
- POST
- PUT
conditions:
- type: HeaderContains
with:
name: Authorization
values:
- Basic
response:
status: 200
headers:
Content-Type: application/json
body:
include: resp.json
- path: /v1/search/:type/:version
methods:
- POST
conditions:
- or:
- type: PathParam
with:
name: type
values:
- foo
- bar
- type: PathParam
with:
name: version
values:
- 1
- 2
response:
status: 200
headers:
Content-Type: application/json
body: >
Hello, World
This is a body
and it uses multiple
lines
- path: /v1/search
methods:
- GET
conditions:
- type: QueryContains
with:
name: foo
values:
- bar
response:
status: 200
headers:
Content-Type: application/json
body: >
Hello, World
This request contained a query param
Config
| Field |
Type |
Description |
Required |
| options |
Options |
Global configuration |
no |
| routes |
Route |
The configuration of all rules mocked checks. |
yes |
Options
| Field |
Type |
Description |
Required |
| address |
string |
The address to bind to |
yes (when not provided via commandline) |
| port |
int |
The port to bind to |
yes (when not provided via commandline) |
| enable_cors |
bool |
Globally enabled cors for the requests. This means that CORS headers will be set and preflight requests (OPTIONS) will be answered by default. This can be turned off on a route basis by setting enable_cors to false there |
yes (when not provided via commandline) |
| min_response_delay_ms |
int |
The minimum delay that shound be waiting until a request responds |
no |
| max_response_delay_ms |
int |
The maximum delay that shound be waiting until a request responds |
no |
Route
| Field |
Type |
Description |
Required |
| path |
string |
The path of the resource. This may include path parameters that can be checked using matchers. Path params start with a colon (:) |
yes |
| methods |
list(string) |
A list of HTTP methods the route responds to. |
yes |
| conditions |
Conditions |
A single, or multiple conditions that are checked once a route is matched. The condition also contains a response that is returned in case of a match. |
yes |
Conditions
| Field |
Type |
Description |
Required |
| type |
string |
The type of a single condition. This can be used if only one condition needs to be used. |
no |
| with |
|
The attributes a condition check of type type requires. Only used here for single conditions. |
no |
| or |
Or |
Define a list of conditions combined with a logical or operator, meaning that at least one condition must be true to emit true. |
no |
| and |
And |
Define a list of conditions combined with a logical and operator, meaning that all conditions must be true to emit true. |
no |
| response |
Response |
The response definition. |
yes |
If neither a single condition or condition combinations with or and and are used, the condition always evaluates to
true.
Or
| Field |
Type |
Description |
Required |
| type |
string |
The type of a single condition. This can be used if only one condition needs to be used. |
no |
| with |
|
The attributes a condition check of type type requires. Only used here for single conditions. |
no |
And
| Field |
Type |
Description |
Required |
| type |
string |
The type of a single condition. This can be used if only one condition needs to be used. |
no |
| with |
|
The attributes a condition check of type type requires. Only used here for single conditions. |
no |
Filter types
PathParam
| Field |
Type |
Description |
Required |
| name |
string |
The name of the path parameter to match. |
yes |
| values |
list(string) or list(number) |
The attribute values to match. Can be strings or numbers. |
yes |
| Field |
Type |
Description |
Required |
| name |
string |
The name of the header to match |
yes |
| values |
list(string) |
A list of strings. If the header contains one of them, it matches. |
yes |
QueryContains
| Field |
Type |
Description |
Required |
| name |
string |
The name of the query param to match |
yes |
| values |
list(string) |
A list of strings. If the query contains one of them, it matches. |
yes |
Response
| Field |
Type |
Description |
Required |
| status |
number |
The HTTP status code to return. |
yes |
| headers |
map(string, string) |
A map of headers to add to the response. |
no |
| body |
Body |
The body to add to the response. |
no |
Body
String Body
A string body contains a yaml formatted string. It may start with | to preserve line breaks or > to convert a yaml
multiline string to a single line response string.
Include Body
| Field |
Type |
Description |
Required |
| include |
string |
A path to a file to include into the response. If it doesn't exist, the server returns an InternalServerError (500) |
yes |