json server

JSON-Server

Wichtig

Betrachten der Beta -V1 -Dokumentation - Nutzbar, aber erwarten Sie Bruchänderungen. Für eine stabile Version finden Sie hier

Hey! Verwenden Sie React, Vue oder Astro? Überprüfen Sie mein neues Projekt MistCSS, um 50% weniger Code zu schreiben.

Installieren

npm install json-server

Verwendung

Erstellen Sie eine db.json oder db.json5 -Datei

{
  "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 Beispiel anzeigen

 {
  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' ,
  } ,
}

Weitere Informationen zum JSON5 -Format finden Sie hier.

Geben Sie es an JSON Server CLI weiter

$ npx json-server db.json

Holen Sie sich eine REST -API

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

Führen Sie json-server --help für eine Liste von Optionen aus

Sponsoren

Sponsoren

Sponsoren

Sponsoren

Werden Sie Sponsor und lassen Sie Ihr Firmenlogo hier

Sponsorware

Notiz

Dieses Projekt verwendet die Fair Source -Lizenz. Nur Organisationen mit mehr als 3 Nutzern werden freundlicherweise gebeten, einen kleinen Betrag über den Sponsoring -Sponsor zur Verwendung beizutragen. Diese Lizenz hilft, das Projekt nachhaltig und gesund zu halten, was allen zugute kommt.

Weitere Informationen, FAQs und die Begründung dahinter finden Sie unter https://fair.io/.

Routen

Basierend auf dem Beispiel db.json erhalten Sie die folgenden Routen:

 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

Parameter

Bedingungen

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

 GET /posts?views_gt=9000

Reichweite

• start
• end
• limit

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

Paginieren

• page
• per_page (default = 10)

 GET /posts?_page=1&_per_page=25

Sortieren

• _sort=f1,f2

 GET /posts?_sort=id,-views

Verschachtelte und Arrayfelder

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

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

Einbetten

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

Löschen

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

Servieren statische Dateien

Wenn Sie ein ./public -Verzeichnis erstellen, wird JSON Server neben der Rest -API seinen Inhalt bedienen.

Sie können auch benutzerdefinierte Verzeichnisse mit -s/--static -hinzufügen.

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

Bemerkenswerte Unterschiede mit V0.17

• id ist immer eine Zeichenfolge und wird für Sie generiert, wenn Sie fehlen
• Verwenden Sie _per_page mit _page anstelle von _limit für die Pagination
• Verwenden Sie Chrome's Network tab > throtling , um Anforderungen anstelle der Option " --delay CLI" zu verzögern