Probando tu servicio REST desde Postman

40

En este artículo revisaremos cómo usar la herramienta Postman para probar individualmente las URIs de tu proyecto REST. Una herramienta como esta te ayudará a tener un mayor control sobre la entrada y salida de las mismas.

Instalación

Primeramente, descargarémos la aplicación de la página oficial de Postman:

https://www.getpostman.com/

Eligiendo nuestro sistema operativo (disponible para Mac, Windows y Linux) y procederemos con la instalación de la aplicación en nuestro sistema a partir del archivo ejecutable descargado.

Configuración

Una vez instalada la aplicación, crearemos una nueva colección (parte superior izquierda) y dentro de ella crearemos los métodos necesarios para consumir nuestro servicio REST, mapeando cada una de las URLs, especificando el verbo HTTP e incluyendo el cuerpo adecuado para cada request.

Nota que puedes agregar tantos request como sean necesarios para probar las URIs de tu servicio REST.

Probando creación de Tokens

Para comenzar las pruebas de nuestras URIs necesitamos obtener un tocken, para ello enviaremos las credenciales de autorización básica y en el cuerpo las credenciales encriptadas de un usuario activo en nuestra base de datos.

La URL por default que usa OAUTH2 sobre Spring Security, con el gran_type: password, se muestra a continuación (asegúrate de la ruta en la configuración de tu proyecto):

<your-project>/oauth/token?grant_type=password

Recuerda que los permisos otorgados para dicho usuario sobre la API dependerán del rol asignado al mismo, puedes consultar más sobre seguridad en servicios rest en este artículo. El token de acceso (subrayado en la siguiente imagen), se usará como llave para el resto de los métodos de nuestro servicio REST.

Nota también que este token tiene una caducidad, después de la cual no será válido. Si excedemos este tiempo, usaremos el token de refresh sobre la misma URI, para obtener un nuevo token valido, con el gran type: refresh_token.

<your-project>/oauth/token?grant_type=refresh_token

Nota que tu servicio REST deberá estar disponible cuando ejecutes estos requests, ya sea apuntando a tu maquina local a tu servidor de desarrollo, pruebas o producción.

Probando métodos del servicio

Una vez que tenemos nuestro token de acceso, ya podemos consumir las URIs del proyecto a las cuales el usuario tenga acceso. En este caso se muestra el consumo de un método para obtener todos los usuarios, utilizando el token de acceso en la URI.

De este modo puedes validar los cuerpos de las respuestas de tu servicio REST individualmente, así como el comportamiento del mismo ante entradas inválidas.

Repositorio en Github

Nota que no todo el código del proyecto fue incluido en este artículo, puedes encontrar el código completo en nuestro repositorio de Github: https://github.com/chuucks/SPRING-REST-API/

Recuerda darnos una estrellita 😉


El uso de Postman para el testing de servicios REST, mostrado en este artículo para la construcción de un proyecto Web, es solo una forma propuesta de hacerlo y tienen fines únicamente ilustrativos para nuestra la comunidad de Codesolt.

Comments

comments