JSON Server (Python version)

This code tries to bring a json-server implementation to the python community with room for improvement.

Get a full fake REST API with zero coding in less than 30 seconds (seriously)

Created with ❤️ for front-end developers who need a quick back-end for prototyping and mocking and use Python instead of Javascript.

• json-server [Javascript implementation] (Original)

 

Table of contents

• Getting started
• Routes
  • Filter
  • Sort
  • Slice
  • Operators
  • Relationships
  • Homepage

Getting started

Install JSON Server

git clone https://github.com/RodrigoProjects/json-server.py

Install Flask with pip

pip install Flask

Create a db.json file with some data

{
    "posts": [
        {
            "id": 1,
            "title": "json-server",
            "author": "typicode",
            "views" : 300
        },
        {
            "id": 2,
            "title": "json-server 2",
            "author": "spln",
            "views" : 50
        }
    ],
    "comments": [
        {
            "id": 1,
            "body": "some comment",
            "postId": 1,
            "author": {
                "name": "typicode"
            }
        },
        {
            "id": 2,
            "body": "some comment",
            "postId": 1,
            "author": {
                "name": "teste"
            }
        }
    ],
    "profile": 
        {
            "name": "typicode"
        }

}

Start JSON Server

python3 json-server/main.py json-tests/db.json 3000

Now if you go to http://localhost:3000/posts/1, you'll get

{ "id": 1, "title": "json-server", "author": "typicode" }

Also when doing requests, it's good to know that:

• If you make POST, PUT, PATCH or DELETE requests, changes will be automatically and safely saved (Thread save) to db.json.
• When you make a POST request json-server will see if you provided at least all the fields that exist in all of the collection. Example:

{
    "persons" : [
        {
            "name" : "John"
        },
        {
            "name" : "Michae"
        }
    ]
}

When adding a new person via POST method you must provide a name to that person because it is consistent in all persons.

• Your request body JSON should be object enclosed, just like the GET output. (for example {"name": "Foobar"})
• A POST, PUT or PATCH request should include a Content-Type: application/json header to use the JSON in the request body. Otherwise it will return a 2XX status code, but without changes being made to the data.

Routes

Based on the previous db.json file, here are all the default routes.

Posts

GET    /posts
GET    /posts/<id>
POST   /posts
PUT    /posts/<id>
PATCH  /posts/<id>
DELETE /posts/<id>

Comments

GET    /comments
GET    /comments/<id>
POST   /comments
PUT    /comments/<id>
PATCH  /comments/<id>
DELETE /comments/<id>

Profile

GET    /profile
GET    /profile/<id>
POST   /profile
PUT    /profile/<id>
PATCH  /profile/<id>
DELETE /profile/<id>

Filter

Use . to access deep properties

GET /posts?title=json-server&author=typicode
GET /posts?id=1&id=2
GET /comments?author.name=typicode

Sort

Add _sort and _order (ascending order by default)

GET /posts?_sort=views&_order=asc
GET /posts/1/comments?_sort=votes&_order=asc

For multiple fields, use the following format:

GET /posts?_sort=user,views&_order=desc,asc

Slice

Add _slice to the query string. This operation takes a start and end position like this: _slice=<start>-<end>

Examples:

• _slice=10-20 from 10 to 20 (inclusive)
• _slices=-10 to 10 (exclusive)
• _slices=30- from 30 (inclusive)

GET /posts?_slice=20-30

Works exactly as python slicing notation (i.e. start is inclusive and end exclusive)

Operators

Add _gte, _lte, _gt and _lt for getting a range

GET /posts?views_gte=50&views_lte=150

Add _ne to exclude a value

GET /posts?id_ne=1

Relationships

To include children resources, add _expand

GET /comments?_expand=postId:posts
GET /comments/1?_expand=postId:posts

Syntax: _expand=<field_to_expand>:<target_db_collection>

(In the future one level depth routes will be possible)

Homepage

Returns default index html file

GET /

CLI usage

json-server <json_file:Required> <port:Optional>

License

MIT