jason-server 0.4.0

JSON as REST API

Jason Server

Get a full fake REST API

Table of contents

• Getting started
  • Singular routes
  • Alternative port

Getting started

Install Jason Server

pip3 install jason-server

Create a db.json file with some data

{
  "articles": [
    { "id": 1, "title": "jason-server", "author": "1" },
    { "id": 2, "title": "jason-routes", "author": "1" }
  ],
  "authors": [
    { "id": 1, "name": "bob"}
  ]
}

Start JSON Server

jason-server watch db.json

Now if you go to http://localhost:8080/articles, you'll get

{ "id": 1, "title": "jason-server", "author": "1" },
{ "id": 2, "title": "jason-routes", "author": "1" }

Routes

Singular routes

GET /authors

Pagination

Use _page and _limit to paginate returned data.

In the Link header you'll get first, prev, next and last links.

GET /articles?_page=2
GET /articles?_page=3&_limit=15

Alternative host (default: localhost)

You can start JSON Server on other host with the --host flag:

$ json-server --host "0.0.0.0" watch db.json

Alternative port (default: 8080)

You can start JSON Server on other ports with the --port flag:

$ json-server --port 8100 watch db.json