Important
Viewing beta v1 documentation – usable but expect breaking changes. For stable version, see here
👋 Hey! Using React, Vue or Astro? Check my new project MistCSS to write 50% less code.
npm install json-serverCreate a db.json or db.json5 file
{
"posts": [
{ "id": "1", "title": "a title", "views": 100 },
{ "id": "2", "title": "another title", "views": 200 }
],
"comments": [
{ "id": "1", "text": "a comment about post 1", "postId": "1" },
{ "id": "2", "text": "another comment about post 1", "postId": "1" }
],
"profile": {
"name": "typicode"
}
}View db.json5 example
{
posts: [
{ id: '1', title: 'a title', views: 100 },
{ id: '2', title: 'another title', views: 200 },
],
comments: [
{ id: '1', text: 'a comment about post 1', postId: '1' },
{ id: '2', text: 'another comment about post 1', postId: '1' },
],
profile: {
name: 'typicode',
},
}You can read more about JSON5 format here.
Pass it to JSON Server CLI
$ npx json-server db.jsonGet a REST API
$ curl http://localhost:3000/posts/1
{
"id": "1",
"title": "a title"
}Run json-server --help for a list of options
| Sponsors |
|---|
 |
| Sponsors |
|---|
| Sponsors | |
|---|---|
Become a sponsor and have your company logo here
Note
This project uses the Fair Source License. Only organizations with 3+ users are kindly asked to contribute a small amount through sponsorship sponsor for usage. This license helps keep the project sustainable and healthy, benefiting everyone.
For more information, FAQs, and the rationale behind this, visit https://fair.io/.
Based on the example db.json, you'll get the following routes:
GET /posts
GET /posts/:id
POST /posts
PUT /posts/:id
PATCH /posts/:id
DELETE /posts/:id
# Same for comments
GET /profile
PUT /profile
PATCH /profile
==lt→<lte→<=gt→>gte→>=ne→!=
GET /posts?views_gt=9000
startendlimit
GET /posts?_start=10&_end=20
GET /posts?_start=10&_limit=10
pageper_page(default = 10)
GET /posts?_page=1&_per_page=25
_sort=f1,f2
GET /posts?_sort=id,-views
x.y.z...x.y.z[i]...
GET /foo?a.b=bar
GET /foo?x.y_lt=100
GET /foo?arr[0]=bar
GET /posts?_embed=comments
GET /comments?_embed=post
DELETE /posts/1
DELETE /posts/1?_dependent=comments
If you create a ./public directory, JSON Server will serve its content in addition to the REST API.
You can also add custom directories using -s/--static option.
json-server -s ./static
json-server -s ./static -s ./node_modulesidis always a string and will be generated for you if missing- use
_per_pagewith_pageinstead of_limitfor pagination - use Chrome's
Network tab > throtlingto delay requests instead of--delayCLI option