Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/umutseven92/apyr
API mocking with Python.
https://github.com/umutseven92/apyr
api fastapi mock python
Last synced: 11 days ago
JSON representation
API mocking with Python.
- Host: GitHub
- URL: https://github.com/umutseven92/apyr
- Owner: umutseven92
- License: mit
- Created: 2021-02-05T02:08:09.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-08T01:14:15.000Z (almost 2 years ago)
- Last Synced: 2024-07-05T14:59:59.012Z (4 months ago)
- Topics: api, fastapi, mock, python
- Language: Python
- Homepage:
- Size: 226 KB
- Stars: 56
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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;
```bash
git clone https://github.com/umutseven92/apyr.git
```
* Edit `endpoints.yaml` with your endpoints (details below).
### Via poetry
* Install [poetry](https://python-poetry.org/docs/#installation).
```bash
cd apyr
poetry install # Install dependencies
poetry run apyr # Run apyr
```
### Via Docker
```bash
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](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) of the endpoint | |
| `path` | ✅ | | Path to the endpoint, appended to the base URL | |
| `status_code` | ✅ | | [Status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) of the response |
| `media_type` | ❌ | `application/json` | [Mime Type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#important_mime_types_for_web_developers) 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
```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:
```bash
~ λ 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` (both inclusive) | `%random_int(0, 20)%`, `%random_int(20, 50)%` |
## Contributing
If you like this project, please consider [donating to the Electronic Frontier Foundation](https://supporters.eff.org/donate).