JSON Server provides REST API mocking based on plain JSON. This is a docker image that eases setup. 1
It was initially forked from the docker-json-server project. Because the supremotribunalfederal team was in need to run it over https in a lightweight image, we decided to refactor the original project and create a new image using Alpine and a self signed certificate.
The server will run with the nodemon library, so it is possible to update the JSON files and server restarts automatically.
NOTE: Nodemon will not work properly if you are using VM Ware because the container can not see that the file were changed in the host.
If you don't need to run the json-server over HTTPS, please use the original json-server image. You can also write your own server.js file and run it over HTTP, but I do recommend to use docker-json-server image in this case.
To run this image you will need to create a folder where you will store your JSON files. basic example
examples/basic/custom
db.json
This command runs from the example folder mapping the container port 8000 to host port 8443.
docker run -d -p 8443:8000 -v $PWD/basic/custom:/data/custom fabriciomendonca/json-server-https
To see your json-server running:
https://localhost:8443
Try changing your db.json file and refresh the browser to see the changes reflected.
It is possible to store your JSON database in any folder inside your project, all you have to do is map them to the /data/custom folder in the container.
JSON Server will convert all first level properties of your db.json file into an endpoint.
{
"users": [
{
"id": 123,
"username": "fabriciomendonca",
"full_name": "Fabricio Mendonça Rodrigues"
}
],
"posts": [
{
"id": 1,
"title": "Lorem Ipsum",
"description": "Lorem Ipsum dolor sit amet...",
"user": 123
}
]
}The server will provide these endpoints:
https://localhost:8443/users
https://localhost:8443/posts
Please see the JSON Server documentation for further information.
If you have to rewrite URLs or match some patterns, just create a routes.json file inside your mapped folder. rewrite example
{
"/posts/:id/comments": "/comments?postId=:id",
"/api/*": "/$1",
"/identities/users": "/users",
"/identities/users/*": "/users/$1"
}Map a folder with your static files to /data/public folder in the container. public folder example
docker run -d -p 8443:8000 -v $PWD/examples/public_folder/custom:/data/custom \
-v $PWD/examples/public_folder/dist:/data/public \
fabriciomendonca/json-server-https
Then access the URL https://localhost:8443/static.js
It is also possible to merge two different db.json files. This is useful when you have some default endpoints shared with multiple modules and aplications and are working in a module of your project that will have its specifcs endpoints that will not be shared.
Inside your project custom folder, create a file named custom-db.json
The custom db example maps the json-server folder from the rewrite example and the custom-db.json file inside it as /data/custom/custom-db.js, the file to be merged with the main JSON database file.
docker run -d -p 8443:8000 \
-v $PWD/examples/rewrite/json-server:/data/custom \
-v $PWD/examples/custom_db/custom-db.json:/data/custom/custom-db.json
fabriciomendonca/json-server-https
You can add a statics.json file to tell the server to rewrite specific URLs and serve the file using the configured Content-Type header. The file can be hosted on a remote server or another folder in the host file system.
docker run -d -p 8443:8000 \
-v $PWD/examples/statics/json-server:/data/custom \
-v $PWD/examples/statics/volumex:/data/volumex \
fabriciomendonca/json-server-https
And the statics.json file will be like this:
[
{
"method": "get",
"url": "/examples/statics/external.js",
"file": {
"path": "https://raw.githubusercontent.com/fabriciomendonca/docker-json-server-https/master/examples/public_folder/dist/static.js",
"is_relative": false,
"content_type": "application/javascript"
}
},
{
"method": "get",
"url": "/some/static/file.css",
"file": {
"path": "./volumex/file.css",
"is_relative": true,
"content_type": "text/css"
}
}
]