En este artículo aprenderemos cómo utilizar una librería de API Rest en Visual Studio Code y qué pruebas se pueden realizar.
Una API es un conjunto de definiciones y protocolos que se utiliza para desarrollar e integrar el software de las aplicaciones. Es decir, comunicarse entre diferentes sistemas.
Fuente: Red Hat.
- Evitar descargar el Postman u otras tecnologías que ocupen espacio en el disco o tener otras cuentas.
- Separación servidor y Cliente.
- Escalabilidad, fiabilidad y flexibilidad.
- Tener instalado Visual Studio Code.
- Ir al menú del lado izquierdo y seleccionar
- Ingresar en la caja “Thunder Client”
- Seleccionar el botón “Instalar”
- Luego se procederá a instalar
Seleccionar el logo de “Thunder Client”
Seleccionamos en el margen izquierdo “New Request” para crear un nuevo endpoint
Ahora vamos a generar las Request de la siguiente url a modo de ejemplo: https://petstore.swagger.io/#/
Ahora vamos a Crear las Request más utilizadas, POST, PUT y GET
- En este caso vamos a seleccionar el combo box “POST”
- Luego ingresamos la URL: https://petstore.swagger.io/v2/pet/
- En el body ingresamos el cuerpo con la opción Json:
- Le damos “Send” y nos devuelve un 200 ok
- También la opción de Salvar o eliminar la request creada
- En este caso, lo guardaremos como Colletion y le damos Submit
- Aquí se puede visualizar que se ha guardado con éxito.
También podemos realizar pruebas del código obtenido. Veamos algunos ejemplos:
1- Seleccionamos la solapa “Test”
2- Seleccionamos en el campo “Select” el combo box y seleccionamos “ResponseCode”
3- Seleccionamos en el campo “Action” el combo box “Equal”
4 – Seleccionar en el campo “Value” ingresamos tipeando el nro “200” como resultado esperado.
- Seleccionamos “Send”
- Luego revisamos en la solapa “Test Result”
- En el caso de que dese obtener un resultado negativo, en el campo “Value” puedo colocar un 401
- También se puede validar el contenido del Request
- Así obteniendo el “Test Results” al seleccionar el “Send” todos como “pass”
- También si se desea se puede correr todas las Collections
- Le damos seleccionar al botón “Run”
- Allí obtendremos los resultados de las mismas
Se puede obtener también los Snipets del código para diferentes plataformas y diferentes tecnologías, por ejemplo: JavaScript, Python, C#
Con esto se puede ejecutar desde la Terminal o desde el Git bash
Ejemplo Terminal en Visual Studio Code:
1 – Seleccionar “Copy”
2 – Ir a la solapa “Terminal”>New terminal
3 – Copiamos el cURL
4 - Obtenemos lo siguiente:
Es posible también en el Git Bush
Allí arriba podemos importar el “curl” ingresando como el siguiente ejemplo:
Se puede exportar la Collections y guardar en la pc.
Esta librería nos permitirá tener unificada la herramienta para realizar pruebas de APIs, ahorrando espacio innecesario en el disco, además teniendo disponibles las funcionales básicas para nuestras pruebas.