Modo de compatibilidad de pasarela o puerta de enlace de la API

API Designer ofrece un modo de compatibilidad de pasarela API para ayudarle a importar su definición en AWS API Gateway y Azure API Management.

Al exportar su API en un modo de compatibilidad de pasarela, API Designer puede modificar su definición para que pueda importarse correctamente en la pasarela seleccionada.

En algunos casos, no hay modificaciones, pero se muestra un mensaje para informarle del problema de compatibilidad que puede encontrar con la definición que exportó.

Exportación de una definición OAS 3.0 para AWS API Gateway

La tabla siguiente describe cómo API Designer gestiona las funciones no compatibles con AWS API Gateway al exportar una definición y qué sucede en AWS API Gateway al importar la definición.

Función de OpenAPI no compatible	Comportamiento de API Designer en la exportación	Comportamiento de AWS API Gateway en la importación
El atributo example no es compatible.	El atributo se conserva.	El atributo se elimina del esquema.
El atributo readOnly no es compatible.	El atributo se conserva.	El atributo se elimina del esquema.
El atributo additionalProperties no es compatible.	El atributo se conserva y se muestra un mensaje informativo.	Se muestra un mensaje de advertencia, pero se puede ignorar y la definición se puede importar correctamente.
Tipos de definición de seguridad: oauth2 no es compatible, http no es compatible, openIdConnect no es compatible.	Los esquemas de seguridad se conservan y se muestra un mensaje informativo.	Se muestra un mensaje de advertencia, pero se puede ignorar y la definición se puede importar correctamente.
Los tipos de datos primitivos en las respuestas no son compatibles.	El tipo primitivo se encapsula en un esquema de componente y se muestra un mensaje de advertencia.	La importación se realiza correctamente.
Los rangos de tipo de medio no son compatibles.	La solicitud o respuesta se conserva y se muestra un mensaje de información.	La importación falla y se muestra un mensaje de advertencia.
La respuesta predeterminada no es compatible.	La respuesta se conserva y se muestra un mensaje informativo.	La importación falla y se muestra un mensaje de advertencia.
Las respuestas de rango no son compatibles.	La respuesta se conserva y se muestra un mensaje informativo.	La importación falla y se muestra un mensaje de advertencia.
Las variables de ruta, los parámetros de consulta y los encabezados deben tener nombres únicos.	Los parámetros se conservan y se muestra un mensaje de error.	La importación falla.

Exportar una definición de OAS/Swagger 2.0 para Azure API Management

La siguiente tabla describe cómo API Designer gestiona las funciones no compatibles con Azure API Management al exportar una definición y qué ocurre en Azure API Management al importar la definición.

Función de OpenAPI no compatible	Comportamiento de API Designer al exportar	Comportamiento de Azure API Management al importar
Los parámetros obligatorios en rutas y consultas deben tener nombres únicos.	Se muestra un mensaje de error.	La importación falla.

¿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