Mockae is a versatile tool that allows you to mock REST APIs using Lua code execution. It allows to easily simulate and test API behaviors, providing a dynamic environment to craft custom responses and logic.
$ npm install mockae
# Or clone the repository
$ git clone https://github.com/cyrilbois/mockae.git
$ cd mockae
$ npm installCreate a db.json file
{
{
"products": [
{
"id": 1, "name": "T-shirt", "price": 19.99
},
{
"id": 2, "name": "Jeans", "price": 49.99
}
],
"users": [
{
"id": 1, "username": "johndoe", "email": "[email protected]"
},
{
"id": 2, "username": "janedoe", "email": "[email protected]"
}
]
}
}In this example, you have created 2 resources: "products" and "users" (2 objects for each resource).
Create a rules.lua file
if request.method() == "POST" and request.pathname() == "/users" then
response.status(400)
response.send('{' ..
'"error":"Bad Request",\n' ..
'"message":"Missing required field: email"' ..
'}')
return response.exit()
endWith these rules, when calling the creation of a "users" a 400 error is returned.
Start the REST API service
$ npx mockae
# Or if you have cloned the repository
$ npm startGet a REST API
$ curl http://localhost:3000/products/1
{
"id": 1,
"name": "T-shirt",
"price": 19.99
}The REST API handles different HTTP methods for creating, retrieving, updating, and deleting resources
GET /products Returns all products
GET /products/2 Returns the product with ID 2
POST /products Create a new product
GET /products/2 Returns the product with ID 2
PUT /products/2 Update the product with ID 2
PATCH /products/2 Update partially the product with ID 2
DELETE /products/2 Delete the product with ID 2
A public API is available on mockae.com to test this fake API.
- page
- limit
GET /products?limit=5 Returns the first 5 products (Page defaults to 1)
GET /products?page=2 Returns 10 products from the second page (default limit is 10)
GET /products?page=2&limit=5 Returns 5 products from the second page (Page starts at 1)
Custom rules are Lua code that allow you to modify the behavior of the fake REST API. With custom rules, you can set conditions based on the request (such as HTTP method, headers, and payload) and define the response (including HTTP status code and payload). This enables you to tailor the API's behavior to suit specific testing and development scenarios.
The Request and Response objects are provided to define the rules.
The Request object is used to represent the request data.
| Method | Description |
|-------------------------|------------------------------------------------------------------------------------|
| request.header(name) | Returns the header `name` |
| request.method() | Returns the HTTP method ('GET', 'POST', 'PUT', 'PATCH', 'DELETE') |
| request.url() | Returns the pathname of the URL (e.g., /users/23). |
| request.id() | Returns the resource ID |
| request.resource() | Returns the resource |
| request.payload(name) | Returns the attribute of the payload object with the name specified in `name` |The Response object is used to update the response, including the HTTP status, headers, and payload.
| Method | Description |
|----------------------------|-------------------------------------------------------------------------------------------------|
| response.status(status) | Sets the HTTP status (e.g., 200, 404, etc.) |
| response.send(payload) | Sets the response payload |
| response.header(name, value) | Sets the header name to value |
| response.exit() | Stops the standard execution of the API (No action or resource loading will be performed) |Contributions are welcome! If you have ideas, improvements, or bug fixes, feel free to submit a pull request. Please ensure your changes keep things simple and easy to maintain. Thank you for helping make this project better!
Launch tests
$ npm testMIT License