En este tutorial vas a aprender como probar una Api con Postman.
Postman es un software de colaboración para todo lo relacionado con el desarrollo y pruebas de Api’s.
Con Postman Podrás:
- Podrás enviar peticiones a Api’s REST, SOPA Y GRAPHQL
- Automatizar pruebas de integración
- Diseñar y probar puntos de entrada de Api
- Documentar y monitorizar
Lo primero que tenemos que tener es instalado el software Postman, el cual se puede descargar desde aquí: www.postman.com
Una vez lo tenemos instalado vamos a crear nuestra primera colección y dentro de la misma crear las carpetas que necesitemos para de esta forma mantener bien organizadas nuestras peticiones, esto también ayudará para la documentación final y de esta forma probar nuestra Api con Postman.
Para este ejemplo creamos una colección con el nombre “Api peliculas v2”. Una vez que creamos la colección dentro de la misma creamos dos carpetas y le ponemos los siguientes nombres:
- Acceso: En esta guardaremos las rutas de autenticación y autorización, es decir la ruta del Login y Registro
- Categorias: En esta guardaremos todas las rutas con las que realizaremos todas las operaciones CRUD (Create, Read, Update, Delete) sobre nuestra api Categorías
Antes de ver como crear las rutas es conveniente entender cuales son los tipos de peticiones comunes y que vamos a usar en este curso
Tipos de peticiones HTTP más comunes:
- GET: Usando esta petición podremos obtener o traer datos de nuestra API
- POST: Usando esta petición podremos insertar o crear un nuevo recurso en nuestra API
- PUT: Usando está petición podremos actualizar un recurso en nuestra api.
- PATCH: Usando está petición podremos actualizar un recurso en nuestra api; la diferencia con el PUT es que en mismo se debe actualizar todo el recurso, es decir todos los campos y el PATCH permite la actualización parcial.
- DELETE: Usando esta petición podremos eliminar un recurso.
Ahora que tenemos más claro los tipos de peticiones vamos a crear dos en la carpeta Acceso:
Registro
Al frente de la carpeta en los tres puntos damos click y en el menú contextual volvemos a dar click en “Add Request”.
Al lado derecho cambiamos el tipo de petición de GET a POST porque vamos a enviar datos ya que pretendemos a través de esta petición es Registrarnos para poder tener una cuenta y usar posteriormente para autenticarnos. También necesitamos cambiar en la pestaña Body a formato Json y enviamos los datos de usuario y password en este mismo formato.
Al presionar en el botón de Send crearemos una cuenta nueva y usaremos estos datos para nuestra siguiente ruta que sera la del login en donde pasaremos el usuario y la contraseña y al presionar Send el nos devolverá un token que tendrá un día de validez. Este token lo necesitaremos para todas nuestra rutas que están protegidas
Como podemos ver en la siguiente imagen para el Login enviaremos nuestros datos de acceso en formato Json: usuario y password y sin son correctos nos dará un código de estado 200 OK y nos devuelve el token.
En esta API en partículas de Categorías las rutas publicas son las de tipo GET y las protegidas son las de tipo POST, PATCH, DELETE. Lo cual nos indica que podemos ver las categorías, categoría individual, pero para crear una nueva categoría, actualizarla o borrarla tendremos que tener un token sino no lo podremos hacer.
Crearemos entonces nuestra petición para obtener todas las categorías, esta es una petición de tipo GET, esta peticion devolverá un código de estado 200 OK:
También crearemos la petición para obtener la categoría individual, esta es una petición de tipo GET, esta peticion devolverá un código de estado 200 OK:
Ahora para la creación de una nueva categoría necesitaremos enviar el token el cual copiamos de la petición Login y creamos una nueva petición de tipo POST, pasamos la ruta que será la misma que usamos para obtener las categorías e ingresamos en la pestaña autorización donde elegimos el tipo de autorización Bearer Token y a la derecha pegamos el código de nuestro token.
En la misma petición pasamos a la pestaña Body cambiamos el formato a Json y enviamos el nombre de la categoría como lo podemos ver en la siguiente imagen, esta petición devolverá un código de estado 201 Created.
Hasta este punto es importante aclarar que este proceso de ingreso del token lo debemos hacer para todas las peticiones de aquí en adelante ya que como mencionamos estan protegidas y solo las podemos usar sin les pasamos un token válido.
Crearemos la petición de tipo PATCH para actualizar una categoría, esta petición devolverá un cógido de estado 204 No Content:
En esta petición lo que hacemos es enviar por la URL el ID de la categoría y en la pestaña Body enviar también el ID y el nombre nuevo que va a tener la categoría, al presionar SEND sucederá que habremos actualido el nombre de la categoría de “Comedia” a “Comedia 2”.
Por último vamos a crear la petición de tipo DELETE para eliminar una categoría existente.
En esta petición lo que haremos será enviar en la URL el ID de la categoría que queremos eliminar y al presionar SEND nos retornará un código de estado 204 No Content y eliminara de nuestra API la categoría que corresponda ese día.
Hemos llegado al final de este tutorial donde aprendimos como probar una Api con Postman. con lo cual ya tendremos los fundamentos para realizar esta tarea.
Mira este mismo tutorial en video:
Si estás interesado en aprender más del desarrollo de API’S RESTful te recomiendo mi curso Master API RESTUL con ASP.NET Core, un curso profesional donde aprenderás como crear una API completa realizando y documentando un proyecto.
Más información aquí: www.render2web.com/master-api-restful-con-asp-net-core-web-api/
