![](\"https://i.imgur.com/IBItATn.png\")
\n \n\n\n
\n\n
\n \n \n \n
\n\n
\n\n
\n \n ![](\"https://i.imgur.com/3mJGTAQ.png\")
\n \n
\n\n[Become a sponsor and have your company logo here](https://github.com/users/typicode/sponsorship)\n\n## Table of contents\n\n\n\n- [Getting started](#getting-started)\n- [Routes](#routes)\n * [Plural routes](#plural-routes)\n * [Singular routes](#singular-routes)\n * [Filter](#filter)\n * [Paginate](#paginate)\n * [Sort](#sort)\n * [Slice](#slice)\n * [Operators](#operators)\n * [Full-text search](#full-text-search)\n * [Relationships](#relationships)\n * [Database](#database)\n * [Homepage](#homepage)\n- [Extras](#extras)\n * [Static file server](#static-file-server)\n * [Alternative port](#alternative-port)\n * [Access from anywhere](#access-from-anywhere)\n * [Remote schema](#remote-schema)\n * [Generate random data](#generate-random-data)\n * [HTTPS](#https)\n * [Add custom routes](#add-custom-routes)\n * [Add middlewares](#add-middlewares)\n * [CLI usage](#cli-usage)\n * [Module](#module)\n + [Simple example](#simple-example)\n + [Custom routes example](#custom-routes-example)\n + [Access control example](#access-control-example)\n + [Custom output example](#custom-output-example)\n + [Rewriter example](#rewriter-example)\n + [Mounting JSON Server on another endpoint example](#mounting-json-server-on-another-endpoint-example)\n + [API](#api)\n * [Deployment](#deployment)\n- [Links](#links)\n * [Video](#video)\n * [Articles](#articles)\n * [Third-party tools](#third-party-tools)\n- [License](#license)\n\n\n\n## Getting started\n\nInstall JSON Server \n\n```\nnpm install -g json-server\n```\n\nCreate a `db.json` file with some data\n\n```json\n{\n \"posts\": [\n { \"id\": 1, \"title\": \"json-server\", \"author\": \"typicode\" }\n ],\n \"comments\": [\n { \"id\": 1, \"body\": \"some comment\", \"postId\": 1 }\n ],\n \"profile\": { \"name\": \"typicode\" }\n}\n```\n\nStart JSON Server\n\n```bash\njson-server --watch db.json\n```\n\nNow if you go to [http://localhost:3000/posts/1](http://localhost:3000/posts/1), you'll get\n\n```json\n{ \"id\": 1, \"title\": \"json-server\", \"author\": \"typicode\" }\n```\n\nAlso when doing requests, it's good to know that:\n\n- If you make POST, PUT, PATCH or DELETE requests, changes will be automatically and safely saved to `db.json` using [lowdb](https://github.com/typicode/lowdb).\n- Your request body JSON should be object enclosed, just like the GET output. (for example `{\"name\": \"Foobar\"}`)\n- Id values are not mutable. Any `id` value in the body of your PUT or PATCH request will be ignored. Only a value set in a POST request will be respected, but only if not already taken.\n- 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. \n\n## Routes\n\nBased on the previous `db.json` file, here are all the default routes. You can also add [other routes](#add-custom-routes) using `--routes`.\n\n### Plural routes\n\n```\nGET /posts\nGET /posts/1\nPOST /posts\nPUT /posts/1\nPATCH /posts/1\nDELETE /posts/1\n```\n\n### Singular routes\n\n```\nGET /profile\nPOST /profile\nPUT /profile\nPATCH /profile\n```\n\n### Filter\n\nUse `.` to access deep properties\n\n```\nGET /posts?title=json-server&author=typicode\nGET /posts?id=1&id=2\nGET /comments?author.name=typicode\n```\n\n### Paginate\n\nUse `_page` and optionally `_limit` to paginate returned data.\n\nIn the `Link` header you'll get `first`, `prev`, `next` and `last` links.\n\n\n```\nGET /posts?_page=7\nGET /posts?_page=7&_limit=20\n```\n\n_10 items are returned by default_\n\n### Sort\n\nAdd `_sort` and `_order` (ascending order by default)\n\n```\nGET /posts?_sort=views&_order=asc\nGET /posts/1/comments?_sort=votes&_order=asc\n```\n\nFor multiple fields, use the following format:\n\n```\nGET /posts?_sort=user,views&_order=desc,asc\n```\n\n### Slice\n\nAdd `_start` and `_end` or `_limit` (an `X-Total-Count` header is included in the response)\n\n```\nGET /posts?_start=20&_end=30\nGET /posts/1/comments?_start=20&_end=30\nGET /posts/1/comments?_start=20&_limit=10\n```\n\n_Works exactly as [Array.slice](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/slice) (i.e. `_start` is inclusive and `_end` exclusive)_\n\n### Operators\n\nAdd `_gte` or `_lte` for getting a range\n\n```\nGET /posts?views_gte=10&views_lte=20\n```\n\nAdd `_ne` to exclude a value\n\n```\nGET /posts?id_ne=1\n```\n\nAdd `_like` to filter (RegExp supported)\n\n```\nGET /posts?title_like=server\n```\n\n### Full-text search\n\nAdd `q`\n\n```\nGET /posts?q=internet\n```\n\n### Relationships\n\nTo include children resources, add `_embed`\n\n```\nGET /posts?_embed=comments\nGET /posts/1?_embed=comments\n```\n\nTo include parent resource, add `_expand`\n\n```\nGET /comments?_expand=post\nGET /comments/1?_expand=post\n```\n\nTo get or create nested resources (by default one level, [add custom routes](#add-custom-routes) for more)\n\n```\nGET /posts/1/comments\nPOST /posts/1/comments\n```\n\n### Database\n\n```\nGET /db\n```\n\n### Homepage\n\nReturns default index file or serves `./public` directory\n\n```\nGET /\n```\n\n## Extras\n\n### Static file server\n\nYou can use JSON Server to serve your HTML, JS and CSS, simply create a `./public` directory\nor use `--static` to set a different static files directory.\n\n```bash\nmkdir public\necho 'hello world' > public/index.html\njson-server db.json\n```\n\n```bash\njson-server db.json --static ./some-other-dir\n```\n\n### Alternative port\n\nYou can start JSON Server on other ports with the `--port` flag:\n\n```bash\n$ json-server --watch db.json --port 3004\n```\n\n### Access from anywhere\n\nYou can access your fake API from anywhere using CORS and JSONP.\n\n### Remote schema\n\nYou can load remote schemas.\n\n```bash\n$ json-server http://example.com/file.json\n$ json-server http://jsonplaceholder.typicode.com/db\n```\n\n### Generate random data\n\nUsing JS instead of a JSON file, you can create data programmatically.\n\n```javascript\n// index.js\nmodule.exports = () => {\n const data = { users: [] }\n // Create 1000 users\n for (let i = 0; i < 1000; i++) {\n data.users.push({ id: i, name: `user${i}` })\n }\n return data\n}\n```\n\n```bash\n$ json-server index.js\n```\n\n__Tip__ use modules like [Faker](https://github.com/Marak/faker.js), [Casual](https://github.com/boo1ean/casual), [Chance](https://github.com/victorquinn/chancejs) or [JSON Schema Faker](https://github.com/json-schema-faker/json-schema-faker).\n\n### HTTPS\n\nThere are many ways to set up SSL in development. One simple way is to use [hotel](https://github.com/typicode/hotel).\n\n### Add custom routes\n\nCreate a `routes.json` file. Pay attention to start every route with `/`.\n\n```json\n{\n \"/api/*\": \"/$1\",\n \"/:resource/:id/show\": \"/:resource/:id\",\n \"/posts/:category\": \"/posts?category=:category\",\n \"/articles\\\\?id=:id\": \"/posts/:id\"\n}\n```\n\nStart JSON Server with `--routes` option.\n\n```bash\njson-server db.json --routes routes.json\n```\n\nNow you can access resources using additional routes.\n\n```sh\n/api/posts # β /posts\n/api/posts/1 # β /posts/1\n/posts/1/show # β /posts/1\n/posts/javascript # β /posts?category=javascript\n/articles?id=1 # β /posts/1\n```\n\n### Add middlewares\n\nYou can add your middlewares from the CLI using `--middlewares` option:\n\n```js\n// hello.js\nmodule.exports = (req, res, next) => {\n res.header('X-Hello', 'World')\n next()\n}\n```\n\n```bash\njson-server db.json --middlewares ./hello.js\njson-server db.json --middlewares ./first.js ./second.js\n```\n\n### CLI usage\n\n```\njson-server [options]