This is a simple HTTP mock server, designed for mocking API endpoints for testing purposes. It allows you to define custom responses for different HTTP methods and routes through a JSON configuration file.
Requirements
- Rust
To get the server running, follow these steps:
Clone the repository to your local machine. Ensure you have Rust installed. If not, install Rust using rustup. Navigate to the root directory of the project. Build the project using Cargo:
cargo buildRun the server with the following command, replacing with your desired port number and <config_path> with the path to your configuration JSON file:
cargo run <port> <config_path>OR
CAFETERA <port> <config_path>The server's behavior is defined by a JSON configuration file. Below is an example of the configuration file structure:
{
"get": [
{
"/health": {
"status": 200,
"body": "API is up and running"
}
},
{
"/users": {
"status": 200,
"body": [
{
"id": 1,
"name": "John Doe",
"email": "[email protected]",
"path": "{{path}}" // This will be replaced with the path of the request
}
]
}
},
{
"/users/{{name}}": {
"status": 200,
"body": {
"id": 1,
"name": "{{name}}",
"email": "[email protected]"
}
}
}
],
"post": [
{
"/users": {
"status": 201,
"body": {
"id": 2,
"name": "Jane Doe",
"email": ""
}
}
}
]
}After starting the server, it will listen for HTTP requests on the specified port. The server matches incoming requests against the paths defined in the configuration file and responds with the corresponding status code and body.
Available wildcard variables:
- {{path}}: The path of the request
- {{query}}: The query string of the request
- {{rand}}: A random number between 0 and 100
- {{arg.<name>}}: The value of the query parameter with the specified name
- {{header.<name>}}: The value of the header with the specified name
- {{<name>}}: The value of the path parameter at the specified index
Contributions are welcome. Please feel free to submit pull requests or open issues to suggest improvements or add new features.