Crea una API REST con JSON SERVER

Es un requerimiento muy común de una aplicación que esta se conecte a una fuente de datos, porque después de procesarlos, estos se van a mostrar en pantalla para que el usuario pueda interactuar con ellos, ya sea un reporte de contabilidad, una lista de contactos o un video en streaming.

En tiempos recientes estas fuentes de datos se modelan como una API REST porque esto permite consumirla fácilmente desde distintos dispositivos y clientes usando el formato JSON.

Cuando estamos en la fase de desarrollo muchas veces la fuente de datos final aún no existe o no está completa, por lo que es necesario contar con una alternativa para que esto no bloqueé nuestra habilidad para escribir las partes de la aplicación que dependen de estos datos.

Prensentando JSON Server

JSON Server es paquete npm que nos da la posibilidad de crear una API REST basada en JSON en nuestro servidor local, ideal para todos aquellos que necesitan un back-end rápido para pruebas y prototipos.

La documentación indica que podemos hacerlo en menos de 30 segundos, hagamos el intento:

Instalar desde npm

1 2 3

$ npm install -g json-server

Crear un archivo db.json
Este archivo sirve como almacén local de datos, el servidor leerá archivo para responder a las peticiones de los clientes.

1 2 3 4 5 6 7 8 9 10 11

{   "posts": [     { "id": 1, "title": "json-server", "author": "typicode" }   ],   "comments": [     { "id": 1, "body": "some comment", "postId": 1 }   ],   "profile": { "name": "typicode" } }

Iniciar el servidor

1 2 3

$ json-server --watch db.json

Esto inicia un servidor local en el puerto 3000 por default.

Hacer peticiones
Todo listo para interactuar con la API, podemos hacer una petición GET

GET http://localhost:3000/posts/1

Y obtener la siguiente respuesta:

1 2 3

{ "id": 1, "title": "json-server", "author": "typicode" }

Eso fue bastante rápido, dependiendo de tu experiencia previa con node y npm esto si podría lograrse en menos de 30 segundos, tiempo record.

Métodos
JSON Server soporta los métodos HTTP más comunes incluyendo GET, POST, PUT, PATCH y DELETE

Es importante mencionar que:
– Los cambios son persistidos en el archivo db.json automáticamente
– Las peticiones POST, PUT y PATCH deben incluir el header Content-Type: application/json para que los nuevos datos sean recibidos correctamente.
– El campo id de cada registro es inmutable, por lo que no se puede alterar.
– Es posible conectarse a la API con JSONP o CORS

Generar datos aleatorios
También es posible usar un archivo JS para generar los datos que JSON Server para a mostrar al usuario, por ejemplo

1 2 3 4 5 6 7 8 9 10 11

// index.js module.exports = function() {   var data = { users: [] }   // crear 1000 users   for (var i = 0; i < 1000; i++) {     data.users.push({ id: i, name: 'user' + i })   }   return data }

Aquí exportamos solo una función que devuelve un objeto con solo una propiedad users, a esta propiedad de añadimos los datos de 1000 usuarios e iniciamos el servidor como:

1 2 3

$ json-server index.js

Mejores datos aleatorios con Faker
Faker es otro módulo de npm usado para obtener datos aleatorios más realistas para usuarios, direcciones, imágenes, teléfonos, etc. Con un script similar al anterior vamos a generar objetos con más propiedades para que parezcan usuarios reales:

1 2 3 4 5 6 7 8 9 10 11 12 13

// create-fake-users.js var faker = require('faker');module.exports = function() {   var data = { users: [] }   // Create 1000 users   for (var i = 1; i <= 1000; i++) {     var randomCard = faker.helpers.userCard(); // userCard con muchas propiedades     randomCard.id = i;     data.users.push(randomCard)   }   return data; }

Iniciamos el servidor:

1 2 3

$ json-server create-fake-users.js

Ejemplo de un usuario generado por Faker

Características

Ahora que tenemos una API funcionando vamos a explorar algunas de las opciones disponibles para hacer las peticiones

Rutas plurales
Estas se refieren a recursos que pueden contener múltiples registros, con un id indicamos qué registro queremos obtener

GET /users
GET /users/1
POST /users
PUT /users/1
PATCH /users/1
DELETE /users/1

Rutas singulares
Estas se refieren a recursos que contienen solo un registro

GET /profile
POST /profile
PUT /profile
PATCH /profile

Paginación
Por default JSON Server devuelve 10 registros al usar la opción de paginación, simplemente debemos añadir la variable _page para indicar el número de página y _limit para cambiar el límite.

GET /users?_page=7
GET /users?_page=7&_limit=20

Ordenamiento

Con la variable _sort indicamos qué propiedad se usa para el ordenamiento y con _orderespecificamos ascendente o descendente (ascendente por default)

GET /posts?_sort=views&_order=DESC
GET /posts/1/comments?_sort=votes&_order=ASC

Operadores
Para incluir un rango en la consulta usamos los operadores _gte or _lte

GET /posts?views_gte=10&views_lte=20

Con _ne excluimos un valor

GET /posts?id_ne=1

Con _like especificamos un filtro

GET /posts?title_like=server

Búsqueda de texto

Para hacer una búsqueda genérica añadimos la variable q

GET /posts?q=internet

Conclusión

Y allí lo tienen, una API REST totalmente funcional con muchas opciones para configuración que podemos usar durante el desarrollo de nuestras apps sin depender de una fuente de datos remota, van a encontrar la documentación completa en el sitio oficial del proyecto JSON Server.

Referencias
JSON Server
Faker

fuente:http://www.enrique7mc.com/2017/03/crear-una-api-rest-en-30-segundos-con-json-server/