Swagger
El conector de Swagger soporta un fichero Swagger con los siguientes tipos de autenticación: básica, OAuth y clave de aplicación. Este conector soporta las especificaciones
OpenAPI 2.0 y
OpenAPI 3.0.
Versión del conector
El conector de Swagger se ha entregado en la versión 8.4.3.
Acción soportada
Activadores soportados
Ninguno
Autorizaciones soportadas
El conector de Swagger soporta la siguiente autorización:
• Ninguno
• Básico
• OAuth
 |
Antes de añadir una conexión de OAuth, asegúrese de seguir los pasos que se proporcionan en la sección sobre
cómo obtener el ID de cliente y los secretos de cliente para Swagger.
|
• Clave de aplicación
Autorizar Swagger
La autorización de Swagger es necesaria para cada acción del conector de Swagger. En la lista de esquemas de autenticación, seleccione uno de los esquemas de autorización:
• Ninguno: permite especificar el URL del fichero Swagger, como https://petstore.swagger.io/v2/swagger.json.
• Básico: para añadir una conexión básica, realice los pasos que se indican a continuación.
1. En la lista de esquemas de autenticación, seleccione Básico.
2. En el campo Conexión de Swagger, pulse en Añadir nuevo.
3. En la ventana Añadir conexión, introduzca los siguientes detalles:
▪ Rótulo de conexión: se rellena automáticamente. El usuario puede proporcionar el rótulo de conexión de su elección.
|
|
En los rótulos se distingue entre mayúsculas y minúsculas. No se deben utilizar espacios, algunos caracteres especiales ni números iniciales.
|
▪ URL de Swagger: URL del fichero Swagger.json.
▪ Nombre de usuario: nombre de usuario para la aplicación de destino.
▪ Contraseña: contraseña para la aplicación de destino.
4. Pulse en Añadir. Se añade una nueva autorización a la lista.
• OAuth: para añadir una conexión OAuth, realice las acciones que se indican a continuación.
Requisito previo: antes de añadir una nueva conexión OAuth, asegúrese de seguir los pasos que se proporcionan en la sección Swagger del tema
Configuración de los valores de OAuth de conector.
1. En la lista de esquemas de autenticación, seleccione OAuth.
2. En el campo Swagger OAuth, pulse en Añadir nueva conexión de Swagger.
3. En la ventana Parámetros, introduzca el valor de Swagger URL y, a continuación, pulse en Permitir. Se abre la ventana Añadir autorización.
4. En la ventana Añadir autorización, edite el valor de Rótulo de autorización, si fuera necesario, e introduzca el URL del recurso.
5. Pulse en Añadir.
• Clave de aplicación: para añadir una nueva conexión de clave de aplicación, realice las acciones que se indican a continuación.
1. En la lista de esquemas de autenticación, seleccione Clave de aplicación.
2. En el campo Swagger AppKey, pulse en Añadir nuevo.
3. En la ventana Añadir conexión, introduzca los siguientes detalles:
▪ Rótulo de conexión: se rellena automáticamente. El usuario puede proporcionar el rótulo de conexión de su elección.
|
|
En los rótulos se distingue entre mayúsculas y minúsculas. No se deben utilizar espacios, algunos caracteres especiales ni números iniciales.
|
▪ URL de Swagger: URL del fichero Swagger.json, como https://petstore.swagger.io/v2/swagger.json.
▪ Clave de aplicación: permite introducir la clave de aplicación de Swagger.
4. Pulse en Añadir.
|
|
Pulse en Probar para validar la autorización.
|
Limitaciones del conector de Swagger
• En la especificación OpenAPI 3.0, el campo del servidor tiene una opción para definir varios URL base. La implementación actual no soporta esta opción, en su lugar, el primer URL base se toma de la matriz del servidor.
• Los siguientes tipos de medios están permitidos en la solicitud: application/json y application/x-www-form-urlencoded. No están permitidos los comodines. Para la respuesta, se permite application/json.
• La carga y descarga de ficheros o imágenes no se soportan.
• Los datos de varias partes o de formulario no se soportan.
• El método de serialización de parámetros es el valor por defecto para todos los parámetros.
• El uso de "one of", "anyOf", "allOf" y "not" no se soporta en el campo de tipo.
• No se permite la autenticación múltiple. Todas las API deben tener una autenticación similar.