Congrats!
-
- You're successfully running JSON Server
-
β§*q٩(ΛαΛ*)Ωβ§*q
-
- To access and modify resources, you can use any HTTP method
-
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
-
Documentation
-- View - README -
-
-
-
-## Sponsors
-
-[[Become a sponsor]](https://patreon.com/typicode)
-
-## Table of contents
-
-
-
-- [Sponsorship](#sponsorship)
-- [Getting started](#getting-started)
-- [Routes](#routes)
- * [Plural routes](#plural-routes)
- * [Singular routes](#singular-routes)
- * [Filter](#filter)
- * [Paginate](#paginate)
- * [Sort](#sort)
- * [Slice](#slice)
- * [Operators](#operators)
- * [Full-text search](#full-text-search)
- * [Relationships](#relationships)
- * [Database](#database)
- * [Homepage](#homepage)
-- [Extras](#extras)
- * [Static file server](#static-file-server)
- * [Alternative port](#alternative-port)
- * [Access from anywhere](#access-from-anywhere)
- * [Remote schema](#remote-schema)
- * [Generate random data](#generate-random-data)
- * [HTTPS](#https)
- * [Add custom routes](#add-custom-routes)
- * [Add middlewares](#add-middlewares)
- * [CLI usage](#cli-usage)
- * [Module](#module)
- + [Simple example](#simple-example)
- + [Custom routes example](#custom-routes-example)
- + [Access control example](#access-control-example)
- + [Custom output example](#custom-output-example)
- + [Rewriter example](#rewriter-example)
- + [Mounting JSON Server on another endpoint example](#mounting-json-server-on-another-endpoint-example)
- + [API](#api)
- * [Deployment](#deployment)
-- [Links](#links)
- * [Video](#video)
- * [Articles](#articles)
- * [Third-party tools](#third-party-tools)
-- [License](#license)
-
-
-
-## Getting started
-
-Install JSON Server
+# JSON-Server
+[](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
```
-npm install -g json-server
-```
-Create a `db.json` file with some data
+## Usage
+
+Create a `db.json` or `db.json5` file
```json
{
+ "$schema": "./node_modules/json-server/schema.json",
"posts": [
- { "id": 1, "title": "json-server", "author": "typicode" }
+ { "id": "1", "title": "a title", "views": 100 },
+ { "id": "2", "title": "another title", "views": 200 }
],
"comments": [
- { "id": 1, "body": "some comment", "postId": 1 }
+ { "id": "1", "text": "a comment about post 1", "postId": "1" },
+ { "id": "2", "text": "another comment about post 1", "postId": "1" }
],
- "profile": { "name": "typicode" }
+ "profile": {
+ "name": "typicode"
+ }
}
```
-Start JSON Server
-
-```bash
-json-server --watch db.json
-```
-
-Now if you go to [http://localhost:3000/posts/1](http://localhost:3000/posts/1), you'll get
-
-```json
-{ "id": 1, "title": "json-server", "author": "typicode" }
-```
-
-Also when doing requests, it's good to know that:
-
-- 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).
-- Your request body JSON should be object enclosed, just like the GET output. (for example `{"name": "Foobar"}`)
-- 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.
-- 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 result in a 200 OK but without changes being made to the data.
-
-## Routes
-
-Based on the previous `db.json` file, here are all the default routes. You can also add [other routes](#add-custom-routes) using `--routes`.
-
-### Plural routes
-
-```
-GET /posts
-GET /posts/1
-POST /posts
-PUT /posts/1
-PATCH /posts/1
-DELETE /posts/1
-```
-
-### Singular routes
-
-```
-GET /profile
-POST /profile
-PUT /profile
-PATCH /profile
-```
-
-### Filter
-
-Use `.` to access deep properties
-
-```
-GET /posts?title=json-server&author=typicode
-GET /posts?id=1&id=2
-GET /comments?author.name=typicode
-```
-
-### Paginate
-
-Use `_page` and optionally `_limit` to paginate returned data.
-
-In the `Link` header you'll get `first`, `prev`, `next` and `last` links.
-
-
-```
-GET /posts?_page=7
-GET /posts?_page=7&_limit=20
-```
-
-_10 items are returned by default_
-
-### Sort
-
-Add `_sort` and `_order` (ascending order by default)
-
-```
-GET /posts?_sort=views&_order=asc
-GET /posts/1/comments?_sort=votes&_order=asc
-```
-
-For multiple fields, use the following format:
-
-```
-GET /posts?_sort=user,views&_order=desc,asc
-```
-
-### Slice
-
-Add `_start` and `_end` or `_limit` (an `X-Total-Count` header is included in the response)
-
-```
-GET /posts?_start=20&_end=30
-GET /posts/1/comments?_start=20&_end=30
-GET /posts/1/comments?_start=20&_limit=10
-```
-
-_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)_
-
-### Operators
-
-Add `_gte` or `_lte` for getting a range
-
-```
-GET /posts?views_gte=10&views_lte=20
-```
-
-Add `_ne` to exclude a value
-
-```
-GET /posts?id_ne=1
-```
-
-Add `_like` to filter (RegExp supported)
-
-```
-GET /posts?title_like=server
-```
-
-### Full-text search
-
-Add `q`
-
-```
-GET /posts?q=internet
-```
-
-### Relationships
-
-To include children resources, add `_embed`
-
-```
-GET /posts?_embed=comments
-GET /posts/1?_embed=comments
-```
-
-To include parent resource, add `_expand`
-
-```
-GET /comments?_expand=post
-GET /comments/1?_expand=post
-```
-
-To get or create nested resources (by default one level, [add custom routes](#add-custom-routes) for more)
+