Postman es una herramienta popular y ampliamente utilizada para probar APIs. Permite a los desarrolladores enviar solicitudes HTTP, inspeccionar respuestas y automatizar pruebas. En esta sección, aprenderás cómo utilizar Postman para probar tus APIs RESTful de manera efectiva.
- Introducción a Postman
¿Qué es Postman?
Postman es una plataforma de colaboración para el desarrollo de APIs que proporciona un entorno amigable para construir, probar, documentar y compartir APIs. Es especialmente útil para:
- Enviar solicitudes HTTP (GET, POST, PUT, DELETE, etc.).
- Verificar respuestas de las APIs.
- Automatizar pruebas.
- Documentar APIs.
Instalación de Postman
Puedes descargar Postman desde su sitio oficial. Está disponible para Windows, macOS y Linux.
- Interfaz de Postman
Componentes principales
- Workspace: Área de trabajo donde puedes organizar tus colecciones y entornos.
- Collections: Conjunto de solicitudes agrupadas que puedes organizar por proyecto o funcionalidad.
- Request Builder: Interfaz donde puedes construir y enviar solicitudes HTTP.
- Response Viewer: Área donde puedes ver las respuestas de las solicitudes enviadas.
Ejemplo de la interfaz
- Enviar una solicitud HTTP
Paso a paso para enviar una solicitud GET
- Abrir Postman.
- Crear una nueva solicitud:
- Haz clic en "New" y selecciona "Request".
- Configurar la solicitud:
- Selecciona el método HTTP (GET, POST, etc.).
- Introduce la URL de la API.
- Añade cualquier parámetro necesario.
- Enviar la solicitud:
- Haz clic en "Send".
Ejemplo práctico
Supongamos que tienes una API en https://jsonplaceholder.typicode.com/posts
.
- Selecciona el método
GET
. - Introduce la URL:
https://jsonplaceholder.typicode.com/posts
. - Haz clic en "Send".
Ver la respuesta
La respuesta de la API se mostrará en el Response Viewer. Puedes ver:
- Status Code: Código de estado HTTP (e.g., 200 OK).
- Headers: Encabezados de la respuesta.
- Body: Cuerpo de la respuesta, que puede estar en formato JSON, XML, etc.
[ { "userId": 1, "id": 1, "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", "body": "quia et suscipit\nsuscipit..." }, ... ]
- Enviar una solicitud POST
Paso a paso para enviar una solicitud POST
- Crear una nueva solicitud.
- Configurar la solicitud:
- Selecciona el método HTTP
POST
. - Introduce la URL de la API.
- En la pestaña "Body", selecciona "raw" y elige el formato (e.g., JSON).
- Introduce el cuerpo de la solicitud.
- Selecciona el método HTTP
- Enviar la solicitud.
Ejemplo práctico
Supongamos que quieres crear un nuevo post en https://jsonplaceholder.typicode.com/posts
.
- Selecciona el método
POST
. - Introduce la URL:
https://jsonplaceholder.typicode.com/posts
. - En la pestaña "Body", selecciona "raw" y elige "JSON".
- Introduce el siguiente JSON en el cuerpo de la solicitud:
- Haz clic en "Send".
Ver la respuesta
La respuesta de la API se mostrará en el Response Viewer. Puedes ver el nuevo recurso creado.
- Automatización de pruebas con Postman
Crear una colección
- Crear una nueva colección:
- Haz clic en "New" y selecciona "Collection".
- Asigna un nombre a la colección.
- Añadir solicitudes a la colección:
- Arrastra y suelta las solicitudes en la colección.
Escribir tests
Postman permite escribir scripts de prueba en JavaScript para automatizar la validación de respuestas.
Ejemplo de script de prueba
pm.test("Status code is 200", function () { pm.response.to.have.status(200); }); pm.test("Response time is less than 200ms", function () { pm.expect(pm.response.responseTime).to.be.below(200); }); pm.test("Response has userId", function () { var jsonData = pm.response.json(); pm.expect(jsonData).to.have.property('userId'); });
Ejecutar colecciones con Newman
Newman es una herramienta de línea de comandos para ejecutar colecciones de Postman.
Instalación de Newman
Ejecutar una colección
- Ejercicio práctico
Ejercicio 1: Crear y probar una API de ejemplo
- Crear una colección en Postman.
- Añadir una solicitud GET:
- URL:
https://jsonplaceholder.typicode.com/posts/1
- Verificar que el status code es 200.
- URL:
- Añadir una solicitud POST:
- URL:
https://jsonplaceholder.typicode.com/posts
- Body:
{ "title": "foo", "body": "bar", "userId": 1 }
- Verificar que el status code es 201.
- URL:
Solución
- Crear la colección:
- Nombre:
API de Ejemplo
.
- Nombre:
- Añadir solicitud GET:
- URL:
https://jsonplaceholder.typicode.com/posts/1
. - Script de prueba:
pm.test("Status code is 200", function () { pm.response.to.have.status(200); });
- URL:
- Añadir solicitud POST:
- URL:
https://jsonplaceholder.typicode.com/posts
. - Body:
{ "title": "foo", "body": "bar", "userId": 1 }
- Script de prueba:
pm.test("Status code is 201", function () { pm.response.to.have.status(201); });
- URL:
Conclusión
Postman es una herramienta poderosa y versátil para probar APIs. Permite a los desarrolladores enviar solicitudes HTTP, verificar respuestas y automatizar pruebas de manera eficiente. En esta sección, aprendiste cómo enviar solicitudes GET y POST, escribir scripts de prueba y automatizar pruebas con Newman. Con esta base, estarás bien preparado para utilizar Postman en tus proyectos de desarrollo de APIs RESTful.
Curso de REST API: Principios de Diseño y Desarrollo de APIs RESTful
Módulo 1: Introducción a las APIs RESTful
Módulo 2: Diseño de APIs RESTful
- Principios de diseño de APIs RESTful
- Recursos y URIs
- Métodos HTTP
- Códigos de estado HTTP
- Versionado de APIs
- Documentación de APIs
Módulo 3: Desarrollo de APIs RESTful
- Configuración del entorno de desarrollo
- Creación de un servidor básico
- Manejo de peticiones y respuestas
- Autenticación y autorización
- Manejo de errores
- Pruebas y validación
Módulo 4: Buenas Prácticas y Seguridad
- Buenas prácticas en el diseño de APIs
- Seguridad en APIs RESTful
- Rate limiting y throttling
- CORS y políticas de seguridad
Módulo 5: Herramientas y Frameworks
- Postman para pruebas de APIs
- Swagger para documentación
- Frameworks populares para APIs RESTful
- Integración continua y despliegue