Photo by Aron on Unsplash

API REST para pruebas

En menos de 5 minutos y publicado en Internet

Actualizado 08/02/2018

Hola según las estadísticas de médium este es uno de mis posts mas leídos 585 vistas, 438 lecturas un 75% de tasa de lectura y 3 aplausos que difícil es conseguir aplausos en Medium fue publicado en el 2016 (por un error muy tonto la elimine y la volví a crear), por ese motivo lo estoy actualizando.

Anteriormente en este post, intente explicar como utilizar Json Server para utilizarlo temporalmente en el ambiente de desarrollo para un equipo frontend.

Requisitos previos

Instalar Json Server

Json server es un paquete de npm que nos permite generar un api restful con los verbos básicos http y los nuestros recursos (endpoints) y todo en base a un archivo db.json donde definimos el esquema del mismo.

Es habitual instalarlo de forma global, pero lo puedes usar de forma local en tu proyecto o usar npx.

Para instalarlo de forma global escribimos en nuestra consola.

npm install -g json-server

La instalación puede tardar unos minutos, pero como se instala globalmente solo se lo hace una sola vez.

Para este caso vamos a definir un esquema para un blog.

Donde tendremos tres recursos.

  • Posts.
  • Comentarios.
  • Perfiles.

Lo guardaremos con el nombre de db.json.

Luego de eso en el directorio donde se encuentra el archivo db.json, levantamos nuestro servidor local con el comando:

$ json-server --watch db.json

Con el esto tenemos el servidor local escuchando en el puerto 3000 puedes visitar

http://localhost:3000

Y tendremos los siguientes recursos

Esto nos permite trabajar en paralelo con el equipo de backend, sin depender de que ellos entreguen un api estable.

Publicarlo en internet

La portabilidad del proyecto es garantizada si usas git, solo es un archivo db.json.

Por alguna razón necesitas tener tu api publicado en Internet, y como es un api de pruebas deberías tener un servidor de pruebas, para eso vamos a utilizar now

Now desde mi punto de vista es uno de los proveedores más sencillos de utilizar gratuitamente, nos permite tener proyectos en Node.js, usar Docker o subir un sitio web de archivos estáticos.

Para comenzar debes instalar now, para Windows y Mac cuentas con una aplicación con interfaz gráfica llamada now desktop, para Linux now cli también está disponible para Mac y Windows para los que preferimos la consola.

Comenzando

En los siguiente pasos vamos a emplear now cli para instalarlo debemos escribir

$ npm install -g now-cli

en este momento mínimo debes tener el esquema en un archivo llamado db.json y un package.json si no lo tienes puedes generarlo fácilmente con

$ npm init --yes
#instalar json-server de forma local
$ npm install json-server --save

npm scripts

Para que nuestro api funcione debemos definir el script “start” en el archivo package.json quedaría así:

probamos desde la consola con el siguiente comando

$ npm run start

finalmente subimos el api a now con el siguiente comando:

Pueden visitar el api de prueba en https://api-obigabdkgi.now.sh