JSON Server provides REST API mocking based on plain JSON. This is a docker image that eases setup.
This docker image is available as a trusted build on the docker index, so there's no setup required. Using this image for the first time will start a download automatically. Further, runs will be immediate, as the image will be cached locally.
The recommended way to run this container looks like this:
$ docker run -d -p 80:80 -v /home/user/articles.json:/data/db.json boogie00/json-serverOr if oyu want to use the example data supply with the image , then you don't need to mount any volumnes and add a finalparameter -d <route of json/js file>. Please refer to data examples for more info on how to use data examples served in this distribution.
docker run --name jserver -it -p 80:80 --rm boogie00/json-server -d todo/db.jsonThe above example exposes the JSON Server REST API on port 80, so that you can now browse to:
http://localhost/
This is a rather common setup following docker's conventions:
-dwill run a detached instance in the background-p {OutsidePort}:80will bind the webserver to the given outside port-v {AbsolutePathToJsonFile}:/data/db.jsonshould be passed to mount the given JSON file into the containerboogie00/json-serverthe name of this docker image
You can supply any number of JSON Server arguments that will be passed through unmodified.
For example if you need to pass routes to the server you can mount the file to be pass and then adding the argument at the end
$ docker run -it --rm clue/json-server --help
$ docker run -it -p 80:80 --name jserver -v ${PWD}/data/todo/db.json:/data/db.json -v ${PWD}/data/todo/routes.json:/data/routes.json --rm boogie00/json-server -r routes.json-iinteractive-topens TTY-p {OutsidePort}:80will bind the webserver to the given outside port--namename of the container to easily find it-v {AbsolutePathToJsonFile}:/data/db.jsonshould be passed to mount the given JSON file into the container-v {AbsolutePathToJsonFile}:/data/routes.jsonshould be passed to mount the given JSON file into the container and use as routes--rmRemove container onces stopsboogie00/json-serverthe name of this docker image-rJson-server parameter for telling server the name of the routes file
If you mount a file to /data/db.json (as in the above example),
it will automatically be used as the plain JSON data source file.
A sample file could look like this:
{
"posts": [
{ "id": 1, "body": "foo" },
{ "id": 2, "body": "bar" }
],
"comments": [
{ "id": 1, "body": "baz", "postId": 1 },
{ "id": 2, "body": "qux", "postId": 2 }
]
}If you mount a file to /data/file.js,
it will automatically be used as a JS seed file.
JSON Server expects JS files to export a function that returns an object. Seed files are useful if you need to programmatically create a lot of data.
A sample file could look like this:
module.exports = function() {
var data = {};
data.posts = [];
data.posts.push({ id: 1, body: 'foo' });
//...
return data;
}This distribution has also added support for faker.js, so in case you want to add a db.js that uses faker.
An example could be something like this:
const faker = require('faker');
const createUser = id => ({
id,
...faker.helpers.createCard(),
avatar: faker.image.avatar(),
registrationDate: faker.date.past()
})
module.exports = () =>({"users": [...Array(200).keys()].map(i => createUser(i))})You can use data that are been shipped with this docker image
To do so, you don't need to mount any additional file to the image since the image has all the required data
Although you will need to pass the route tot eh file alocated in the image with an aditional parameter -d
$ docker run -it -p 80:80 --name jserver --rm boogie00/json-server -d todo/db.json$ docker run -it -p 80:80 --name jserver --rm boogie00/json-server -d faker/db.js$ docker run -it -p 80:80 --name jserver --rm boogie00/json-server -d starwars/db.json