¶ 1. Visión General.
Swagger es una herramienta que facilita la creación, documentación y consumo de APIs (Application Programming Interface). Proporciona una interfaz interactiva que permite a los desarrolladores y consumidores externos visualizar, probar e interactuar con los endpoints de una API de manera intuitiva. A través de Swagger, es posible generar automáticamente la documentación de la API a partir del código fuente, asegurando que la documentación esté siempre actualizada y sincronizada con las implementaciones. Además, Swagger admite una amplia gama de lenguajes de programación y frameworks.
¶ 2. Autenticación y Autorización.
Tenemos algunas formas de autenticación en Swagger, las más comúnmente utilizadas son:
- Basic: Autorización utilizando usuario y contraseña, separados por ":" convertidos en Base64;
- Bearer: Es un Schema que utiliza un Token del tipo JWP (Jason Web Token) que autoriza al usuario a acceder a las APIs;
- OAuth 2: Es un protocolo de autorización mediante Token;
Para acceder a algunas APIs de T6 es necesario que el usuario esté autenticado (con usuario y contraseña u otro método).
¶ 3. Uso.
Para abrir Swagger, utilizaremos el endpoint: URL.../swagger/index.html
- Ejemplo de endpoint en un entorno cloud:
qablue.tech6cloud.com/swagger/index.html; (en este caso, qablue es el nombre de su dominio.) - Ejemplo de endpoint en un entorno local:
(servidor del IIS)/(nombre de la aplicación en IIS)/swagger/index.html
La URL informada antes de la API dependerá de su dominio en la cloud o, en caso de un entorno local, de las configuraciones proporcionadas en su IIS (Internet Information Services).
Al acceder al endpoint, se abrirá una página que contiene todas las APIs del sistema. Haga clic en 
para expandir la API seleccionada.
- Se mostrarán los parámetros necesarios para la ejecución de la API, así como las posibles respuestas que el sistema puede devolver, además de una visualización detallada de la solicitud. Para habilitar la inserción de los parámetros y ejecutar la API, haga clic en "Try it out";
- Al hacer clic en "Try it out", se habilitará la inserción de datos en los parámetros, además de mostrar el botón "Execute", que ejecutará la API según los parámetros ingresados;
- Al ejecutar la API, Swagger devolverá una respuesta con el código y la descripción, informando sobre el éxito o el fallo de la ejecución. En caso de fallo, devolverá detalladamente el código de error y el motivo del fallo.
Para obtener más información y formas de consumir las APIs, visite nuestro centro de ayuda: Integración de Datos.