https://github.com/clue/docker-json-server

JSON Server docker image, REST API mocking based on plain JSON
https://github.com/clue/docker-json-server

Last synced: 4 days ago
JSON representation

JSON Server docker image, REST API mocking based on plain JSON

• Host: GitHub
• URL: https://github.com/clue/docker-json-server
• Owner: clue
• Created: 2014-10-15T23:11:34.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2020-06-18T06:40:18.000Z (over 4 years ago)
• Last Synced: 2024-12-31T13:12:07.586Z (11 days ago)
• Language: Shell
• Size: 127 KB
• Stars: 311
• Watchers: 11
• Forks: 133
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - docker-json-server - JSON Server docker image, REST API mocking based on plain JSON (Shell)

README

        
# docker-json-server

[JSON Server](https://github.com/typicode/json-server) provides REST API mocking based on plain JSON.

This is a [docker](https://www.docker.io) image that eases setup.

## Usage

This docker image is available as a [trusted build on the docker index](https://index.docker.io/u/clue/json-server/),

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:

```bash

$ docker run -d -p 80:80 -v /home/user/articles.json:/data/db.json clue/json-server

```

The 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:

* `-d` will run a detached instance in the background

* `-p {OutsidePort}:80` will bind the webserver to the given outside port

* `-v {AbsolutePathToJsonFile}:/data/db.json` should be passed to mount the given JSON file into the container

* `clue/json-server` the name of this docker image

### Help

You can supply any number of JSON Server arguments that will be passed through unmodified.

```bash

$ docker run -it --rm clue/json-server --help

```

### JSON source

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:

```json

{

  "posts": [

    { "id": 1, "body": "foo" },

    { "id": 2, "body": "bar" }

  ],

  "comments": [

    { "id": 1, "body": "baz", "postId": 1 },

    { "id": 2, "body": "qux", "postId": 2 }

  ]

}

```

### JS seed file

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 programmaticaly create a lot of data.

A sample file could look like this:

```javascript

module.exports = function() {

  var data = {};

  data.posts = [];

  data.posts.push({ id: 1, body: 'foo' });

  //...

  return data;

}

```