Compatibilidad con OpenAPI Specification 3.0 | Qlik Cloud Ayuda
Saltar al contenido principal Saltar al contenido complementario
Recursos de Qlik
Cargando la búsqueda de SearchUnify Si necesita ayuda con su producto, comuníquese con el Soporte de Qlik.
Portal de clientes de Qlik
Cargando la búsqueda de SearchUnify Si necesita ayuda con su producto, comuníquese con el Soporte de Qlik.
Portal de clientes de Qlik

Compatibilidad con OpenAPI Specification 3.0

Diseñe una API con OpenAPI Specification (OAS) 3.0 usando API Designer.

OpenAPI Specification 3.0 incluye nuevas funciones, lo que aporta más expresividad y productividad a los diseñadores de las API.

Para más información sobre OpenAPI, consulte la documentación de Swagger.

Componentes

Los componentes le permiten reutilizar varios elementos en una API. Estos elementos pueden ser:
  • Variables de ruta
  • Parámetros de consulta
  • Encabezados
  • Respuestas

Combinaciones

Las combinaciones le permiten crear un nuevo tipo de datos combinando varios otros tipos de datos. API Designer admite dos tipos de combinaciones:
  • La composición (allOf) le permite agregar propiedades de esquema de diferentes esquemas. Por ejemplo, puede definir un tipo de datos Empresa reutilizando todas las propiedades de los tipos existentes Contactar y Error.
    Ejemplo de una composición.
  • El polimorfismo (oneOf /anyOf) permite crear una entidad que puede usar las propiedades de diferentes tipos de datos.
    • oneOf permite definir un tipo de datos que contiene las propiedades de uno de los tipos seleccionados. Por ejemplo, si crea una operación para obtener información sobre una cuenta de servicio, puede definir la respuesta utilizando la combinación oneOf para obtener todas las propiedades de Error o todas las propiedades de ServiceAccountCount.
      Ejemplo de un polimorfismo.
    • anyOf le permite definir un tipo de datos que contiene las propiedades de uno o varios de los tipos seleccionados. Por ejemplo, puede definir un tipo de datos SistemaNervioso y un tipo Esqueleto que contienen propiedades diferentes y utilizar la combinación anyOf para crear un tipo de datos que contenga cualquier propiedad de cualquiera de estos tipos.

      Una combinación anyOf es válida siempre que contenga todos los parámetros requeridos de al menos uno de los tipos de datos seleccionados. El siguiente ejemplo utiliza la propiedad brain_weight de SistemaNervioso tipo y skull_height y dientes propiedades de Esqueleto.

      Ejemplo de combinación utilizando los tipos de datos SistemaNervioso y Esqueleto.

Para más información sobre composición y polimorfismo, consulte Herencia y polimorfismo y Diferencia entre anyOf y oneOf.

Respuestas

OAS 3.0 le permite definir nuevos tipos de respuestas para sus operaciones:
  • Rangos de respuesta: en lugar de definir una respuesta como 200, puede configurarla como 2XX, de modo que incluya respuestas de 200 a 299.
  • Respuestas predeterminadas: puede definir una respuesta predeterminada que se devolverá cuando no se defina una respuesta específica o de rango.
Las respuestas definidas con un código explícito tienen prioridad sobre los rangos de respuesta y las respuestas predeterminadas, y los rangos de respuesta tienen prioridad sobre las respuestas predeterminadas. En el siguiente ejemplo:
  • El parámetro 204 response está definida y tiene prioridad sobre las demás.
  • El parámetro 2XX response se aplica a los códigos de respuesta del 200 al 203 y del 205 al 299.
  • El parámetro predeterminado response se aplica a todas las respuestas 1XX, 3XX, 4XX y 5XX.
Sección de respuestas.

Seguridad

OAS 3.0 incorpora nuevos esquemas de seguridad para su API:
  • Autenticación de portador
  • OpenIdConnect

Restricciones

OAS 3.0 le permite indicar que algunas propiedades son de solo lectura o de solo escritura.

Esta opción solo está disponible en tipos de datos y no se puede definir en solicitudes o respuestas a nivel de operación.

Ejemplo de restricción.

¿Esta página le ha sido útil?

Si encuentra algún problema con esta página o su contenido (errores tipográficos, pasos que faltan o errores técnicos), no dude en ponerse en contacto con nosotros.

Deje aquí sus comentarios