json server

JSON服務器

重要的

查看Beta V1文檔 - 可用但期望破裂的變化。對於穩定版本，請參閱此處

嘿！使用React，Vue還是Astro？檢查我的新項目mistcss，以少50％的代碼編寫。

安裝

npm install json-server

用法

創建db.json或db.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 "
  }
}

查看db.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' ,
  } ,
}

您可以在此處閱讀有關JSON5格式的更多信息。

將其傳遞給JSON服務器CLI

$ npx json-server db.json

獲取休息API

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

運行json-server --help以獲取選項列表

贊助商

贊助商

贊助商

贊助商

成為贊助商，並在此處擁有您的公司徽標

贊助軟件

筆記

該項目使用公平源許可證。只有擁有3個以上用戶的組織才能通過贊助商的使用來貢獻少量。該許可有助於使項目保持可持續性和健康，從而使所有人受益。

有關更多信息，FAQS和此背後的理由，請訪問https://fair.io/。

路線

根據示例db.json ，您將獲得以下路線：

 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

參數

狀況

• → ==
• lt → <
• lte → <=
• gt → >
• gte → >=
• ne → !=

 GET /posts?views_gt=9000

範圍

• start
• end
• limit

 GET /posts?_start=10&_end=20
GET /posts?_start=10&_limit=10

分頁

• page
• per_page （默認= 10）

 GET /posts?_page=1&_per_page=25

種類

• _sort=f1,f2

 GET /posts?_sort=id,-views

嵌套和數組字段

• xyz..
• xyz[i]...

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

嵌入

 GET /posts?_embed=comments
GET /comments?_embed=post

刪除

 DELETE /posts/1
DELETE /posts/1?_dependent=comments

服務靜態文件

如果您創建./public目錄，則JSON服務器除REST API外還將提供其內容。

您還可以使用-s/--static選項添加自定義目錄。

json-server -s ./static
json-server -s ./static -s ./node_modules

v0.17的顯著差異

• id始終是一個字符串，如果丟失，將為您生成
• 使用_per_page與_page代替_limit進行分頁
• 使用Chrome的Network tab > throtling來延遲請求，而不是--delay CLI選項