> [!IMPORTANT] > Viewing alpha v1 documentation – usable but expect breaking changes. For stable version, see [here](https://github.com/typicode/json-server/tree/v0) # json-server [![Node.js CI](https://github.com/typicode/json-server/actions/workflows/node.js.yml/badge.svg)](https://github.com/typicode/json-server/actions/workflows/node.js.yml) ## Install ```shell npm install json-server ``` ## Usage Create a `db.json` or `db.json5` file ```json { "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

```json5 { 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](https://github.com/json5/json5).

Pass it to JSON Server CLI ```shell $ npx json-server db.json ``` Get a REST API ```shell $ curl http://localhost:3000/posts/1 { "id": "1", "title": "a title" } ``` Run `json-server --help` for a list of options ## Sponsors ✨ | Sponsors | | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | |

| |

| [Become a sponsor and have your company logo here](https://github.com/users/typicode/sponsorship) ## Routes 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 ``` ## Params ### Conditions - ` ` → `==` - `lt` → `<` - `lte` → `<=` - `gt` → `>` - `gte` → `>=` - `ne` → `!=` ``` GET /posts?views_gt=9000 ``` ### Range - `start` - `end` - `limit` ``` GET /posts?_start=10&_end=20 GET /posts?_start=10&_limit=10 ``` ### Paginate - `page` - `per_page` (default = 10) ``` GET /posts?_page=1&_per_page=25 ``` ### Sort - `_sort=f1,f2` ``` GET /posts?_sort=id,-views ``` ### Nested and array fields - `x.y.z...` - `x.y.z[i]...` ``` GET /foo?a.b=bar GET /foo?x.y_lt=100 GET /foo?arr[0]=bar ``` ### Embed ``` GET /posts?_embed=comments GET /comments?_embed=post ``` ## Delete ``` DELETE /posts/1 DELETE /posts/1?_dependent=comments ``` ## Serving static files If you create a `./public` directory, JSON Serve will serve its content in addition to the REST API. You can also add custom directories using `-s/--static` option. ```sh json-server -s ./static json-server -s ./static -s ./node_modules ``` ## License This project uses the [Fair Source License](https://fair.io/). Note: Only organizations with 3+ users need to contribute a small amount through sponsorship [sponsor](https://github.com/sponsors/typicode) 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/](https://fair.io/).

	Stars	Issues	Version	Updated	Created
axios-mock-adapter	3,368	94	1.22.0	8 months ago	8 years ago
json-server			1.0.0-alpha.23	3 months ago	10 years ago
mockaroo			1.0.0	a year ago	9 years ago
mocky	26	0	0.1.11	7 years ago	11 years ago
nock	12,528	68	13.5.4	2 months ago	13 years ago

axios-mock-adapter vs json-server vs mockaroo vs mocky vs nock

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past