Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 1.46 KB

README.md

File metadata and controls

84 lines (55 loc) · 1.46 KB
Raw

json-server.py

PyPI

Fake REST API with zero coding.

This project is heavily inspired by json-server in JavaScript.

Requires Python 3.6+.

Installation

It's highly recommended to install with pipx.

$ pipx install json-server.py

Or install with pip at your own risk:

$ pip3 install json-server.py

Get Started

Create a db.json file with following content:

{
  "posts": []
}

Start a server:

$ json-server db.json

Create a post:

$ curl -H 'content-type: application/json' -d '{"content":"blablabla"}' http://localhost:3000/posts

List all posts:

$ curl http://localhost:3000/posts

Usage

Usage: json-server [OPTIONS] [FILENAME]

  Start a JSON server.

  FILENAME refers to the JSON file where your data is stored. `db.json` will
  be used if not specified.

Options:
  --version        Show the version and exit.
  -b, --bind TEXT  Set address to bind, default as `:3000`
  --help           Show this message and exit.

Note:

  • Collections must be contained in your data file before starting the server, otherwise the server cannot decide the type of resources.

Examples

# Start with default config
$ json-server

# Listen on port 3000
$ json-server -b :3000

# Specify a json file
$ json-server db.json