apyr 
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.
Installation
- Clone the project;
git clone https://github.com/umutseven92/apyr.git
- Edit
endpoints.yamlwith your endpoints (details below).
Via poetry
- Install poetry.
cd apyr
poetry install # Install dependencies
poetry run apyr # Run apyr
Port can be set by -p PORT. The default port is 8000.
Via Docker
cd apyr
docker-compose up --build -d
Configuration
Your 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.
Example endpoints.yaml
# 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: >
I've quit better jobs than this.
Ghostbusters, whaddya want.
# 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.html
Example usage
An 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!
Functions
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 |
%random_int(0, 20)%, %random_int(20, 50)% |
1 Jul 11, 2022
4k Jan 5, 2023
3.8k Jan 3, 2023
2.1k Dec 31, 2022
39 Jan 6, 2023
6 Jan 28, 2022
2 Nov 21, 2021
4 Dec 16, 2021
1 Jan 18, 2022
1.9k Dec 30, 2022
39 Nov 18, 2022
25.7k Jan 04, 2023
134 Sep 15, 2022
64 Dec 17, 2022
62 Oct 10, 2022
2 Jun 17, 2022
24 Sep 10, 2022
3k Jan 04, 2023
1 Nov 29, 2021
1.7k Dec 24, 2022
255 Jan 04, 2023
2 Jan 16, 2022
1 Oct 28, 2021
122 Nov 22, 2022
632 Jan 08, 2023
10 Jul 01, 2022
3.1k Jan 04, 2023
1 Oct 06, 2022
55 Oct 30, 2022