json server

servidor json

Importante

Visualización de la documentación Beta V1: utilizable pero espere cambios de ruptura. Para la versión estable, vea aquí

¡Ey! ¿Usando React, Vue o Astro? Consulte mi nuevo proyecto Mistcss para escribir un 50% menos de código.

Instalar

npm install json-server

Uso

Crear un archivo db.json o 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 "
  }
}

Ver DB.JSON5 Ejemplo

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

Puedes leer más sobre el formato JSON5 aquí.

Pásalo a JSON Server CLI

$ npx json-server db.json

Obtenga una API REST

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

Ejecutar json-server --help para una lista de opciones

Patrocinadores

Patrocinadores

Patrocinadores

Patrocinadores

Conviértase en patrocinador y tenga el logotipo de su empresa aquí

Patrocinio

Nota

Este proyecto utiliza la licencia fuente justa. Solo se les pide amablemente a las organizaciones con más de 3 usuarios que contribuyan con una pequeña cantidad a través del patrocinador de patrocinio para el uso. Esta licencia ayuda a mantener el proyecto sostenible y saludable, beneficiando a todos.

Para obtener más información, preguntas frecuentes y la razón detrás de esto, visite https://fair.io/.

Rutas

Basado en el ejemplo db.json , obtendrá las siguientes rutas:

 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

Parámetros

Condiciones

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

 GET /posts?views_gt=9000

Rango

• start
• end
• limit

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

Paginar

• page
• per_page (predeterminado = 10)

 GET /posts?_page=1&_per_page=25

Clasificar

• _sort=f1,f2

 GET /posts?_sort=id,-views

Campos anidados y de matriz

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

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

Empotrar

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

Borrar

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

Servir archivos estáticos

Si crea un directorio ./public , el servidor JSON servirá su contenido además de la API REST.

También puede agregar directorios personalizados usando la opción -s/--static .

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

Diferencias notables con V0.17

• id siempre es una cadena y se generará para usted si falta
• Use _per_page con _page en lugar de _limit para paginación
• Utilice Network tab > throtling para retrasar las solicitudes en lugar de -opción CLI --delay