4.4 Probando tus servicios con POSTMAN

Podemos probar los demás servicios con Postman el cual nos permite realizar pruebas sobre los servicios

Primero descarga e instala Postman.

Probar el servicio GET para obtener todos las categorías

  1. Selecciona el método a probar, en este caso probaremos el GET

  2. Teclea la URL a probar http://localhost:50685/api/Categorias

  3. Da clic en el botón SEND

  4. Abajo en la pestaña de Body vemos un arreglo vacío ya que aún no agregamos ninguna categoría

Probar el servicio POST

  1. Seleccionar el método POST

  2. Seleccionar la pestaña Body

  3. Seleccionar la opción raw

  4. Seleccionar el tipo JSON (application/json)

  5. Teclear el objeto JSON a agregar

  6. Dar clic en el botón Send

  7. Abajo puedes ver el Status en este caso fue 201 Created y en el Body te regresa el Json de la categoría insertada. Si vuelves a probar el servicio GET, obtendrás la categoría recien creada. Del lado izquierdo en la pestaña History se va guardado la lista de servicios llamados por si lo deseas volver a llamar.

Puedes probar las validaciones dejando el Json con una clave negativa y el nombre en null.​ Mas adelante explicaré como generar los mensajes en español.

Probar el servicio PUT

Para modificar un registro

  1. Seleccionar el método PUT

  2. Teclear la URL http://localhost:50685/api/Categorias/1 donde 1 es el Id del registro que deseas modificar

  3. Seleccionar la pestaña Body

  4. Seleccionar la opción raw

  5. Seleccionar el tipo JSON (application/json)

  6. Teclear el objeto JSON a agregar

  7. Dar clic en el botón Send

  8. Abajo puedes ver el Status en este caso fue 204 No Content y no regresa ningún valor.

Probar el servicio GET para obtener una categoría por Id

Podemos consultar un registro en particular indicado el Id de la categoría

  1. Seleccionar el método GET

  2. Teclear la URL http://localhost:50685/api/Categorias/1 donde 1 es el Id del registro que deseas consultar

  3. Dar clic en el botón Send

  4. Abajo puedes ver el Status en este caso fue 200 OK y regresa la categoría con el Id 1

Probar el servicio DELETE

  1. Seleccionar el método DELETE

  2. Teclear la URL http://localhost:50685/api/Categorias/1 donde 1 es el Id del registro que deseas borrar

  3. Dar clic en el botón Send

  4. Abajo puedes ver el Status en este caso fue 200 OK y te regresa la categoría que se borró.

Como crear tus pruebas automáticas con Postman

En la sección de Test puedes crear las pruebas para validar que el servicio funcione correctamente, y posteriormente puedes configurar azure devops para que se corran estas pruebas después de cada release de tu aplicación.

Primero crea una nueva colección en Postman. Selecciona el tab Collectios luego en New Collection

Agrega un Nombre a tu colección en mi caso será PruebasCategorias y una Descripción

Se tienen diferentes pestañas:

  • Authorization: Permite definir la autorización que utilizan todos los servicios de tu colección, una forma de autorización común en servicios es JWT que se explica en la sección Seguridad

  • Pre-request Scripts: Puedes agregar código javascript que se ejecute antes de la llamada a cada servicio rest. Por ejemplo puedes guardar un log para guardar la fecha actual en la que se ejecuta cada servicio

  • Test: Aquí agregas código javascript para ejecutarse después de cada servicio, por ejemplo si todos los servicios que vas a probar regresan un estatus 200 lo puedes poner aquí en lugar de agregar el código para revisar que cada servicio regrese status 200.

  • Variables: Puedes cambiar o definir valores de variables que necesiten todos tus servicios.

La colección se agrega del lado izquierdo, ahora haz clic en AddRequest

Por lo general para pruebas automáticas, se suele agregar el método que vas a probar, luego los parámetros que necesitas y lo que debe regresar el método, en mi caso voy a probar el método GET del servicio Categorias y de momento como solo tengo una categoria voy a probar que regrese 1 Categoria, por lo tanto el nombre es GetCategorias_Id1Regresa1Categoria, puedes agregar una descripción. Por último da clic en Save to PruebasCategorias

Del lado izquierdo se agrega el método GET da clic y del lado derecha agrega la petición al servicio categorias

http://localhost:5000/api/Categorias/1

Para probar en postman se usa código javascript, puedes ver la documentación oficial

Los test empiezan con pm.test, a continuación teclea la descripción del test entre paréntesis, por ejemplo voy a probar que el servicio regrese un status 200, que es OK, entonces puedes agregar Status Correcto, luego agrega una función javascript, para poder probar que el status code del servicio es 200 postman cuenta con la instrucción. El código final queda asi:

pm.test("Status Correcto", function() {
pm.response.to.be.ok;
});

Como ya sabemos que el 1 es analgésicos vamos a acceder al json regresado por el servicio y comprobar que la propiedad nombre sea Analgésicos. Con la función pm.expect puedes comprobar los valores regresados por el servicio y con la función pm.response.json() obtienes un objeto json que tiene como atributos del objeto las propiedades del json, por ejemplo tiene el Nombre, Id, Clave

pm.test("El campo nombre es " + nombre, function() {
pm.expect(pm.response.json().Nombre).to.equal("Análgesicos");
});

Da clic en la pestaña Test y agrega el siguiente código

pm.test("Status Correcto", function() {
pm.response.to.be.ok;
});
var nombre = "Análgesicos";
pm.test("El campo nombre es " + nombre, function() {
pm.expect(pm.response.json().Nombre).to.equal("Análgesicos");
});

Si das clic en el botón Send verás en la petaña Test Results en verde los 2 casos de prueba.

Esta solo fue una breve introducción. Mas adelante se agregará una sección para incluir estos test en postman en Azure Devops para que se ejecuten luego de subir una nueva versión del sistema al servidor.

Postman tiene opciones interesantes como monitorear los servicios cada hora, un día a la semana o todos los días de la semana a una hora, crear workspaces para generar la documentación de tus servicios, convertir la respuesta de tus servicios en gráficas, tablas html y compartirla con los usuarios de tu equipo, todo esto se explicará mas adelante.

Otra forma de probar y documentar tus servicios es con la extensión de Swagger que instalamos previamente.