{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/256", "result": {"data":{"issuesJson":{"id":"df5b38f7-d765-5e23-9cd7-3c0fcb0f0fb6","title":"typicode/json-server: 一款能够直接将 json 内容转成 REST API 接口的工具，你可以在日常开发中，通过该工具快速进行调试","number":256,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Repostypicode/json-server
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

json-server

\n

\"Node.js

\n

Important

Viewing beta v1 documentation – usable but expect breaking changes. For stable version, see here

\n
\n

👋 Hey! Using React, Vue or Astro? Check my new project MistCSS to write 50% less code.

\n

Install

\n
npm install json-server
\n

Usage

\n

Create a db.json or db.json5 file

\n
{\n  \"posts\": [\n    { \"id\": \"1\", \"title\": \"a title\", \"views\": 100 },\n    { \"id\": \"2\", \"title\": \"another title\", \"views\": 200 }\n  ],\n  \"comments\": [\n    { \"id\": \"1\", \"text\": \"a comment about post 1\", \"postId\": \"1\" },\n    { \"id\": \"2\", \"text\": \"another comment about post 1\", \"postId\": \"1\" }\n  ],\n  \"profile\": {\n    \"name\": \"typicode\"\n  }\n}
\n
\nView db.json5 example\n
{\n  posts: [\n    { id: '1', title: 'a title', views: 100 },\n    { id: '2', title: 'another title', views: 200 },\n  ],\n  comments: [\n    { id: '1', text: 'a comment about post 1', postId: '1' },\n    { id: '2', text: 'another comment about post 1', postId: '1' },\n  ],\n  profile: {\n    name: 'typicode',\n  },\n}
\n

You can read more about JSON5 format here.

\n
\n

Pass it to JSON Server CLI

\n
$ npx json-server db.json
\n

Get a REST API

\n
$ curl http://localhost:3000/posts/1\n{\n  \"id\": \"1\",\n  \"title\": \"a title\",\n  \"views\": 100\n}
\n

Run json-server --help for a list of options

\n

Sponsors ✨

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Sponsors
\n\n\n\n\n\n\n\n\n\n\n\n
Sponsors
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Sponsors
\"Delivery
\n

Become a sponsor and have your company logo here

\n

Sponsorware

\n

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.

\n

For more information, FAQs, and the rationale behind this, visit https://fair.io/.

\n
\n

Routes

\n

Based on the example db.json, you'll get the following routes:

\n
GET    /posts\nGET    /posts/:id\nPOST   /posts\nPUT    /posts/:id\nPATCH  /posts/:id\nDELETE /posts/:id\n\n# Same for comments\n
\n
GET   /profile\nPUT   /profile\nPATCH /profile\n
\n

Params

\n

Conditions

\n\n
GET /posts?views_gt=9000\n
\n

Range

\n\n
GET /posts?_start=10&_end=20\nGET /posts?_start=10&_limit=10\n
\n

Paginate

\n\n
GET /posts?_page=1&_per_page=25\n
\n

Sort

\n\n
GET /posts?_sort=id,-views\n
\n

Nested and array fields

\n\n
GET /foo?a.b=bar\nGET /foo?x.y_lt=100\nGET /foo?arr[0]=bar\n
\n

Embed

\n
GET /posts?_embed=comments\nGET /comments?_embed=post\n
\n

Delete

\n
DELETE /posts/1\nDELETE /posts/1?_dependent=comments\n
\n

Serving static files

\n

If you create a ./public directory, JSON Server will serve its content in addition to the REST API.

\n

You can also add custom directories using -s/--static option.

\n
json-server -s ./static\njson-server -s ./static -s ./node_modules
\n

Notable differences with v0.17

\n","updatedAt":"2025-05-21T16:03:51Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"命令行工具","color":"e05879"}},{"node":{"name":"typicode","color":"68998b"}}]},"comments":{"edges":[]}}},"pageContext":{"number":256,"previous":{"title":"AykutSarac/jsoncrack.com: 将 JSON、YAML、XML、CSV 等各种数据格式转换为交互式图表的工具","number":255},"next":{"title":"jwma/jump-jump: 开箱即用，Golang 开发的一个功能完善的短链接系统","number":257}}}, "staticQueryHashes": ["151096407","2861350382"]}