apyr (all lowercase) is a simple & easy to use mock API server.
It's great for front-end development when your API is not ready, or when you are prototyping an API. It's also very useful for demos & hackathons.
- Clone the project;
git clone https://github.com/umutseven92/apyr.git- Edit
endpoints.yamlwith your endpoints (details below).
- Install poetry.
cd apyr
poetry install # Install dependencies
poetry run apyr # Run apyrcd apyr
docker-compose up --build -dYour endpoints are defined in endpoints.yaml. An example endpoints.yaml comes with the project; feel free to edit
it.
| Syntax | Required | Default | Description |
|---|---|---|---|
method |
✅ | HTTP method of the endpoint | |
path |
✅ | Path to the endpoint, appended to the base URL | |
status_code |
✅ | Status code of the response | |
media_type |
❌ | application/json |
Mime Type of the response |
content† |
❌ | Body of the response | |
content_path† |
❌ | Path to the response body |
† Both content and content_path can't be set at the same time.
# A GET method that returns a list of employees.
- method: GET
path: test/employees
status_code: 200
content: >
[
{ "first_name": "Peter", "last_name": "Venkman" },
{ "first_name": "Ray", "last_name": "Stantz" },
{ "first_name": "Egon", "last_name": "Spengler" },
]
# A GET method that returns an employee.
# Take note of the two %functions%- the employee's first name, last name and age will be random at every response.
- method: GET
path: test/employee/2
status_code: 200
content: >
{
"first_name": "%random_first_name(female)%",
"last_name": "%random_last_name()%",
"age": %random_int(20, 50)%
}
# A POST method that returns a 500. Great for testing error pages.
- method: POST
path: test/employee
media_type: text
status_code: 500
content: An unexpected error occured while creating the employee.
# A PUT method that returns a 201. Does not return a body- content is optional.
- method: PUT
path: test/employee/3
status_code: 201
# A GET method that returns an HTML page.
- method: GET
path: test/help
status_code: 200
media_type: text/html
content: >
<!DOCTYPE html>
<html>
<body>
<h1>I've quit better jobs than this.</h1>
<p>Ghostbusters, whaddya want.</p>
</body>
</html>
# The same method as above, but the content is referenced from another file. Path is relative to project root.
- method: GET
path: test/help2
status_code: 200
media_type: text/html
content_path: assets/help.htmlAn example of making a curl request to our second endpoint defined above:
~ λ curl 0.0.0.0:8000/test/employee/2 -v
> GET /test/employee/2 HTTP/1.1
>
< HTTP/1.1 200 OK
< server: uvicorn
< content-length: 52
< content-type: application/json
<
{ "first_name": "Geoffrey", "last_name": "Greeley", "age": 28 }No need to restart apyr after editing endpoints.yaml- it's all taken care of!
apyr supports different kinds of functions inside the content parameter.
Currently supported functions are:
| Name | Parameters | Description | Examples |
|---|---|---|---|
%random_first_name(gender)% |
gender: Optional string. Can be male or female. If left empty, will default to both |
Will be replaced by a random first name | %random_first_name(male)%, %random_first_name(female)%, %random_first_name()% |
%random_last_name()% |
Will be replaced by a random last name | %random_last_name()% |
|
%random_int(start, end)% |
start: Required int, end: Required int |
Will be replaced by a random integer between start and end (both inclusive) |
%random_int(0, 20)%, %random_int(20, 50)% |
If you like this project, please consider donating to the Electronic Frontier Foundation.