json server

JSON-SERVER

สำคัญ

การดูเอกสาร Beta V1 - ใช้งานได้ แต่คาดว่าจะมีการเปลี่ยนแปลง สำหรับเวอร์ชันที่เสถียรดูที่นี่

เฮ้! ใช้ React, Vue หรือ Astro? ตรวจสอบ Project 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 Server CLI

$ npx json-server db.json

รับ API ที่เหลือ

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

เรียกใช้ json-server --help สำหรับรายการตัวเลือก

ผู้สนับสนุน

ผู้สนับสนุน

ผู้สนับสนุน

ผู้สนับสนุน

เป็นสปอนเซอร์และมีโลโก้ บริษัท ของคุณที่นี่

ผู้สนับสนุน

บันทึก

โครงการนี้ใช้ใบอนุญาตแหล่งที่มาอย่างยุติธรรม เฉพาะองค์กรที่มีผู้ใช้ 3+ คนเท่านั้นที่ขอให้มีส่วนร่วมในจำนวนเล็กน้อยผ่านสปอนเซอร์สปอนเซอร์สำหรับการใช้งาน ใบอนุญาตนี้ช่วยให้โครงการยั่งยืนและมีสุขภาพดีเป็นประโยชน์ต่อทุกคน

สำหรับข้อมูลเพิ่มเติมคำถามที่พบบ่อยและเหตุผลที่อยู่เบื้องหลังนี้ไปที่ 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 public เซิร์ฟเวอร์ JSON จะให้บริการเนื้อหานอกเหนือจาก REST API

นอกจากนี้คุณยังสามารถเพิ่มไดเรกทอรีที่กำหนดเองโดยใช้ตัวเลือก -s/--static

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

ความแตกต่างที่โดดเด่นกับ v0.17

• id เป็นสตริงเสมอและจะถูกสร้างขึ้นสำหรับคุณหากหายไป
• ใช้ _per_page กับ _page แทน _limit สำหรับการปนเปื้อน
• ใช้ Network tab > throtling เพื่อชะลอการร้องขอแทนที่จะเป็นตัวเลือก --delay CLI