modo de compatibilidade do gateway de API
O API Designer oferece um modo de compatibilidade do gateway de API para ajudar você a importar sua definição para o AWS API Gateway e o Azure API Management.
Ao exportar sua API em um modo de compatibilidade de gateway, o API Designer pode modificar sua definição para que ela possa ser importada com sucesso para o gateway selecionado.
Em alguns casos, não há modificações, mas é exibida uma mensagem para informar sobre o problema de compatibilidade que você pode encontrar com a definição que exportou.
Exportando uma definição da OAS 3.0 para o AWS API Gateway
A tabela a seguir descreve como o API Designer lida com os recursos não aceitos pelo AWS API Gateway ao exportar uma definição e o que acontece no AWS API Gateway ao importar a definição.
| Recurso OpenAPI não permitido | Comportamento do API Designer na exportação | Comportamento do AWS API Gateway na importação |
|---|---|---|
| O atributo example não é permitido. | O atributo é preservado. | O atributo é removido do esquema. |
| O atributo readOnly não é permitido. | O atributo é preservado. | O atributo é removido do esquema. |
| O atributo additionalProperties não é permitido. | O atributo é preservado e uma mensagem informativa é exibida. | Uma mensagem de aviso é exibida, mas pode ser ignorada e a definição pode ser importada com sucesso. |
Tipos de definição de segurança:
|
Os esquemas de segurança são preservados e uma mensagem informativa é exibida. | Uma mensagem de aviso é exibida, mas pode ser ignorada e a definição pode ser importada com sucesso. |
| Tipos de dados primitivos em respostas não são permitidos. | O tipo primitivo é encapsulado em um esquema de componente e uma mensagem de aviso é exibida. | A importação é bem-sucedida. |
| Intervalos de tipo de mídia não são permitidos. | A solicitação ou resposta é preservada e uma mensagem informativa é exibida. | A importação falha e uma mensagem de aviso é exibida. |
| Resposta padrão não é permitida. | A resposta é preservada e uma mensagem informativa é exibida. | A importação falha e uma mensagem de aviso é exibida. |
| Respostas de intervalo não são permitidas. | A resposta é preservada e uma mensagem informativa é exibida. | A importação falha e uma mensagem de aviso é exibida. |
| Variáveis de caminho, parâmetros de consulta e cabeçalhos devem ter nomes exclusivos. | Os parâmetros são preservados e uma mensagem de erro é exibida. | A importação falha. |
Exportando uma definição OAS/Swagger 2.0 para o Azure API Management
A tabela a seguir descreve como o API Designer lida com os recursos não compatíveis com o Azure API Management ao exportar uma definição e o que acontece no Azure API Management ao importar a definição.
| Recurso OpenAPI não permitido | Comportamento do API Designer na exportação | Comportamento do Azure API Management na importação |
|---|---|---|
| Os parâmetros obrigatórios em caminhos e consultas devem ter nomes exclusivos. | Uma mensagem de erro é exibida. | A importação falha. |