Wednesday, November 22, 2017
Desarrollo Web

Creando una API REST en Ubuntu con JSON-Server para pruebas

>helibertoarias helibertoarias
septiembre 18, 2016

Necesitas una API  REST para pruebas  que sea rapida de crear y sin necesidad de programar ni una sola línea? en ese caso te presento JSON-Server.  Básicamente para crearla necesitarás; un archivo .json con tus datos y tener instalado NodeJs, NPM, json-server y finalmente ejecutar el comando para iniciar tu servidor. Para pruebas puedes utilizar tu proyecto ya sea haciendo uso de AngularJS, jQuery o sencillamente POSTMAN.

El siguiente tutorial ha sido realizado sobre Ubuntu 16.

Prequisitos

A continuación unos pasos previos para configurar lo necesario para JSON-Server.

1. NodeJS

Instalamos NodeJS, el penúltimo comando nos evitará futuros problemas por ejemplo al momento de iniciar el JSON-Server.

2. Node Package Manager NPM

Instalamos el Administrador de paquetes el cual nos servirá para descargar JSON-Server.

3. Descargar Google Chrome

Descargamos e instalamos Chrome ya que vamos a utilizar una extensión llamada Postman.

4. Descargar Postman

Descargamos e instalamos la extensión para poder realizar pruebas a nuestra API Rest pero generalmente esta es invocada con AngularJS o  jQuery entre otras alternativas.

 

Luego de descargado y configurado los elementos requeridos procedemos a configurar nuestro JSON-Server

Instalando Json-Server

Descargamos e instalamos globalmente el paquete, luego creamos el directorio en el que se almacenará nuestro archivo .json con la información a publicar.

Configurando archivo .json

Creamos y almacenamos el archivo app.json en el directorio /home/test/Documents/json-server/test/. Este archivo contiene la información que deseamos compartir.

Iniciando Json-Server

Este comando permite iniciar el servidor. Recuerda ejecutarlo desde el directorio /home/test/Documents/json-server/test/ que es donde está el app.json.

Interactuando con Postman

Hasta este punto hemos iniciado nuestro servicio, si queremos ver si se inició correctamente podemos ingresar a http://localhost:8080 desde la cual veremos la pagina inicial que provee JSON-Server. Finalmente adiciona algunas imágenes de las peticiones GET, PUT, POST y DELETE creadas con el servicio.

Recuerda que GET es utilizada para recuperación de registros, PUT para actualizar registros, POST para adicionar registros y DELETE para eliminación de registros.

 

Petición GET para recupera registros.

Petición GET para recuperar registros.

 

Petición POST para adicionar un registro.

Petición POST para adicionar un registro.

 

Petición GET para recuperar un registro.

Petición GET para recuperar un registro.

 

Petición PUT para actualizar un registro.

Petición PUT para actualizar un registro.

 

Petición DELETE para eliminar un registro.

Petición DELETE para eliminar un registro.

 

Si deseas profundizar más en cómo utilizar JSON-Server visita su sitio y en este encontraras mas parámetros para por ejemplo retornar datos paginados, ordenados, filtrados, habilitar/deshabilitar Cross Origin, adicionar delay a peticiones y muchas opciones más.

(Visitado 297 veces, 1 visitas hoy)
Heliberto Arias
Mi nombre es Heliberto Arias y vivo en Barranquilla, Colombia. Soy desarrollador de software. He estado en el desarrollo de software desde el 2007. Cree este blog en 2013 para compartir lo que voy aprendiendo cada año y en el escribo de tecnologías Microsoft principalmente en C# (y aunque he usado VB declaro que lo detesto) y SQL Server desarrollado aplicaciones y servicios web entre otro s.Me gustaría mucho si te suscribes a mis redes en Youtube, Google+, Twitter, e Instagram.

Comments

No comments found!

Leave a Comment

Your email address will not be published.

veinte − diecinueve =

Login
Remember me
Lost your Password?
Password Reset
Login