Create A REST API With JSON Server

Create A REST API With JSON Server

Una tarea muy común para los desarrolladores de front-end es simular un servicio backend REST para entregar algunos datos en formato JSON a la aplicación front-end y asegurarse de que todo funciona como se espera. Naturalmente, podríamos configurar un servidor backend completo, por ejemplo, utilizando Node.js, Express y MongoDB. Aunque, tenemos una interesante opción para configurar, “algo parecido”, muy rápidamente mediante JSON Server.

JSON Server es un proyecto sencillo que nos ayuda a configurar una API REST con operaciones CRUD muy rápidamente. Veamos aquí como podemos montarlo en pocos pasos…

Instalando JSON Server

JSON Server está disponible mediante paquete NPM y la instalación puede realizarse utilizando el gestor de paquetes Node.js:

npm instalar -g json-server

Al añadir la opción -g nos estamos asegurando que el paquete esté instalado globalmente en nuestro sistema.

Configurando el JSON File (DB)

Ahora vamos a crear nuestro fichero JSON con el nombre db.json. Este archivo contiene los datos que deben ser expuestos por la API de REST y para los objetos contenidos en la estructura JSON, los entpoints CRUD se crearán automáticamente. Unos datos de ejemplo podrían ser:

{
  "employees": [
    {
      "id": 1,
      "first_name": "Sebastian",
      "last_name": "Eschweiler",
      "email": "sebastian@codingthesmartway.com"
    },
    {
      "id": 2,
      "first_name": "Steve",
      "last_name": "Palmer",
      "email": "steve@codingthesmartway.com"
    },
    {
      "id": 3,
      "first_name": "Ann",
      "last_name": "Smith",
      "email": "ann@codingthesmartway.com"
    }
  ]
}

La estructura JSON consta de un objeto “employees” que tiene asignados tres sets de datos. Cada objeto “employees” consta de cuatro propiedades: id, first_name, last_name, email.

Arrancando el JSON Server

Iniciemos el servidor JSON ejecutando el siguiente comando:

json-server -H 0.0.0.0 -p 3000 --watch db.json

Al usar --watch db.json nos aseguramos de que el servidor se inicie en modo de vigilancia, lo que significa que vigila los cambios de archivos y actualiza la API expuesta en consecuencia.

Una vez tengamos el servicio en marcha, podemos acceder a: http://localhost:3000/employees y ver los primeros resultados.

JSON Server Dashboard

Podemos utilizar el servidor como un API REST normal, mediante comandos como:

GET    /employees
GET    /employees/{id}
POST   /employees
PUT    /employees/{id}
PATCH  /employees/{id}
DELETE /employees/{id}

Autor: Joakim Vivas

comments powered by Disqus