Modalità di compatibilità del gateway API
API Designer offre una modalità di compatibilità del gateway API per aiutarti a importare la tua definizione in AWS API Gateway e Azure API Management.
Durante l'esportazione dell'API in una modalità di compatibilità del gateway, API Designer potrebbe modificare la definizione in modo che possa essere importata correttamente nel gateway selezionato.
In alcuni casi, non ci sono modifiche ma viene visualizzato un messaggio per informarti del problema di compatibilità che potresti riscontrare con la definizione esportata.
Esportazione di una definizione OAS 3.0 per AWS API Gateway
La seguente tabella descrive come API Designer gestisce le funzionalità non supportate da AWS API Gateway durante l'esportazione di una definizione e cosa succede in AWS API Gateway quando si importa la definizione.
| Funzionalità OpenAPI non supportata | Comportamento di API Designer all'esportazione | Comportamento di AWS API Gateway all'importazione |
|---|---|---|
| L'attributo example non è supportato. | L'attributo viene preservato. | L'attributo viene rimosso dallo schema. |
| L'attributo readOnly non è supportato. | L'attributo viene preservato. | L'attributo viene rimosso dallo schema. |
| L'attributo additionalProperties non è supportato. | L'attributo viene preservato e viene visualizzato un messaggio informativo. | Viene visualizzato un messaggio di avviso ma può essere ignorato e la definizione può essere importata correttamente. |
Tipi di definizione di sicurezza:
|
Gli schemi di sicurezza vengono preservati e viene visualizzato un messaggio informativo. | Viene visualizzato un messaggio di avviso ma può essere ignorato e la definizione può essere importata correttamente. |
| I tipi di dati primitivi nelle risposte non sono supportati. | Il tipo primitivo viene racchiuso in uno schema di componente e viene visualizzato un messaggio di avviso. | L'importazione ha esito positivo. |
| Gli intervalli di tipi di media non sono supportati. | La richiesta o la risposta viene preservata e viene visualizzato un messaggio informativo. | L'importazione non riesce e viene visualizzato un messaggio di avviso. |
| La risposta predefinita non è supportata. | La risposta viene preservata e viene visualizzato un messaggio informativo. | L'importazione non riesce e viene visualizzato un messaggio di avviso. |
| Le risposte a intervallo non sono supportate. | La risposta viene preservata e viene visualizzato un messaggio informativo. | L'importazione non riesce e viene visualizzato un messaggio di avviso. |
| Le variabili di percorso, i parametri di query e le intestazioni devono avere nomi univoci. | I parametri vengono preservati e viene visualizzato un messaggio di errore. | L'importazione non riesce. |
Esportazione di una definizione OAS/Swagger 2.0 per Azure API Management
La seguente tabella descrive come API Designer gestisce le funzionalità non supportate da Azure API Management durante l'esportazione di una definizione e cosa succede in Azure API Management quando si importa la definizione.
| Funzionalità OpenAPI non supportata | Comportamento di API Designer all'esportazione | Comportamento di Azure API Management all'importazione |
|---|---|---|
| I parametri obbligatori sia nei percorsi che nelle query devono avere nomi univoci. | Viene visualizzato un messaggio di errore. | L'importazione non riesce. |