# json-server **Repository Path**: mirrors/json-server ## Basic Information - **Project Name**: json-server - **Description**: Get a full fake REST API with zero coding in less than 30 seconds (seriously) - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 8 - **Forks**: 0 - **Created**: 2017-04-03 - **Last Updated**: 2026-02-14 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 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) > [!IMPORTANT] > Viewing beta v1 documentation – usable but expect breaking changes. For stable version, see [here](https://github.com/typicode/json-server/tree/v0.17.4) > [!NOTE] > Using React ⚛️ and tired of CSS-in-JS? See [MistCSS](https://github.com/typicode/mistcss) 👀 ## Install ```shell npm install json-server ``` ## Usage Create a `db.json` or `db.json5` file ```json { "$schema": "./node_modules/json-server/schema.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", "views": 100 } ``` Run `json-server --help` for a list of options ## Sponsors ✨ ### Gold | | | :--------------------------------------------------------------------------------------------------------------------------------------------------------: | |

| |

### Silver | | | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | |

| ### Bronze | | | | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | |

| [Become a sponsor and have your company logo here](https://github.com/users/typicode/sponsorship) ## Sponsorware > [!NOTE] > This project uses the [Fair Source License](https://fair.io/). Only organizations with 3+ users are kindly asked 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/). ## 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 Server 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 ``` ## Notable differences with v0.17 - `id` is always a string and will be generated for you if missing - use `_per_page` with `_page` instead of `_limit`for pagination - use `_embed` instead of `_expand` - use Chrome's `Network tab > throtling` to delay requests instead of `--delay` CLI option