Introducción
Este documento proporciona una guía detallada para el uso de la API de nuestra aplicación, utilizando dos herramientas clave: Swagger y Postman. Swagger se utiliza para describir la API de forma detallada, incluyendo los endpoints disponibles, los parámetros requeridos y las respuestas esperadas. Por otro lado, Postman se utiliza como cliente para probar directamente los endpoints de la API y validar su funcionalidad.
Requisitos previos
- Se recomienda tener conocimientos básicos sobre APIs RESTful.
- Es necesario tener instaladas la herramienta Postman aunque puede ser utilizada la versión web también.
Estructura del documento
- Descripción de la API: Se detallan los endpoints disponibles, sus parámetros y las respuestas esperadas.
- Uso de Swagger: Se explica cómo utilizar Swagger para explorar la API y generar código cliente.
- Uso de Postman: Se muestra cómo importar la colección de la API en Postman y realizar peticiones.
Contacto
Si tiene alguna pregunta o necesita asistencia adicional, no dude en ponerse en contacto con nuestro equipo de soporte técnico.