1
0
mirror of https://github.com/vimagick/dockerfiles.git synced 2024-12-23 01:39:27 +02:00
dockerfiles/json-server/README.md
2024-02-06 22:02:53 +08:00

77 lines
1.3 KiB
Markdown

json-server
===========
![](https://badge.imagelayers.io/vimagick/json-server:latest.svg)
Get a full fake REST API with zero coding in less than 30 seconds (seriously) with [json-server][1].
## docker-compose.yml
```yaml
version: "3.8"
services:
json-server:
image: vimagick/json-server
command: -h 0.0.0.0 -p 3000 -s ./public db.json
init: true
ports:
- "3000:3000"
volumes:
- ./data:/data
restart: unless-stopped
```
>> :warning: `init: true` is required. [read more][2]
## data/db.json
```json
{
"posts": [
{
"id": "1",
"title": "a title",
"views": 100
},
{
"id": "2",
"title": "another title",
"views": 200
}
],
"comments": [
{
"id": "1",
"text": "a comment about post 1",
"postId": "1"
},
{
"id": "2",
"text": "another comment about post 1",
"postId": "1"
}
],
"profile": {
"name": "typicode"
}
}
```
## up and running
```bash
docker-compose up -d
pip install httpie
http GET :3000/posts
http POST :3000/posts id:=3 title=hello author=world
http PUT :3000/posts/3 title=Hello author=World
http PATCH :3000/posts/3 title=HELLO
http DELETE :3000/posts/3
http GET :3000/db
```
[1]: https://github.com/typicode/json-server
[2]: https://developpaper.com/avoid-running-nodejs-as-pid-1-under-the-docker-image/