json server

json-server

Penting

Melihat Dokumentasi Beta V1 - Dapat digunakan tetapi harapkan perubahan perubahan. Untuk versi stabil, lihat di sini

Hai! Menggunakan React, Vue atau Astro? Periksa proyek baru saya Mistcss untuk menulis kode 50% lebih sedikit.

Memasang

npm install json-server

Penggunaan

Buat file db.json atau 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 "
  }
}

Lihat contoh 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' ,
  } ,
}

Anda dapat membaca lebih lanjut tentang format JSON5 di sini.

Meneruskannya ke json server cli

$ npx json-server db.json

Dapatkan API istirahat

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

Jalankan json-server --help untuk daftar opsi

Sponsor

Sponsor

Sponsor

Sponsor

Menjadi sponsor dan minta logo perusahaan Anda di sini

Sponsorware

Catatan

Proyek ini menggunakan lisensi sumber yang adil. Hanya organisasi dengan 3+ pengguna yang diminta untuk menyumbang sejumlah kecil melalui sponsor sponsor untuk penggunaan. Lisensi ini membantu menjaga proyek tetap berkelanjutan dan sehat, menguntungkan semua orang.

Untuk informasi lebih lanjut, FAQ, dan alasan di balik ini, kunjungi https://fair.io/.

Rute

Berdasarkan contoh db.json , Anda akan mendapatkan rute berikut:

 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

Params

Kondisi

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

 GET /posts?views_gt=9000

Jangkauan

• start
• end
• limit

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

Paginat

• page
• per_page (default = 10)

 GET /posts?_page=1&_per_page=25

Menyortir

• _sort=f1,f2

 GET /posts?_sort=id,-views

Bidang bersarang dan array

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

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

Menanamkan

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

Menghapus

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

Melayani file statis

Jika Anda membuat direktori ./public , JSON Server akan melayani kontennya selain API REST.

Anda juga dapat menambahkan direktori khusus menggunakan -s/--static .

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

Perbedaan penting dengan v0.17

• id selalu menjadi string dan akan dihasilkan untuk Anda jika hilang
• Gunakan _per_page dengan _page bukan _limit untuk pagination
• Gunakan Network tab > throtling untuk menunda permintaan alih -alih --delay CLI opsi