Modalità di compatibilità del gateway API
Ultimo aggiornamento: 20/10/2026API Contracts offre una modalità di compatibilità con API gateway per aiutarti a importare la tua definizione in AWS API Gateway e Azure API Management.
Quando esporti la tua API in una modalità di compatibilità con il gateway, API Contracts potrebbe modificare la tua definizione in modo che possa essere importata correttamente nel gateway selezionato.
In alcuni casi non sono presenti modifiche, ma viene visualizzato un messaggio per informare l'utente del problema di compatibilità che potrebbe riscontrare con la definizione esportata.
Esportazione di una definizione OAS 3.0 per AWS API Gateway
La tabella seguente descrive come API Contracts gestisce le funzionalità non supportate da AWS API Gateway durante l'esportazione di una definizione e cosa accade in AWS API Gateway quando si importa la definizione.
| Funzionalità OpenAPI non supportata | Contratti API comportamento all'esportazione | Comportamento di AWS API Gateway all'importazione |
|---|---|---|
| L'attributo example non è supportato. | L'attributo viene mantenuto. | L'attributo viene rimosso dallo schema. |
| L'attributo readOnly non è supportato. | L'attributo viene mantenuto. | L'attributo viene rimosso dallo schema. |
| L'attributo additionalProperties non è supportato. | L'attributo viene mantenuto 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 mantenuti 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 non sono supportati nelle risposte. | Il tipo primitivo viene incapsulato in uno schema di componente e viene visualizzato un messaggio di avviso. | L'importazione viene completata correttamente. |
| Gli intervalli di tipi di supporto non sono supportati. | La richiesta o la risposta viene conservata 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 conservata e viene visualizzato un messaggio informativo. | L'importazione non riesce e viene visualizzato un messaggio di avviso. |
| Le risposte di intervallo non sono supportate. | La risposta viene conservata 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 mantenuti e viene visualizzato un messaggio di errore. | L'importazione non riesce. |
Esportazione di una definizione OAS/Swagger 2.0 per Azure API Management
La tabella seguente descrive in che modo API Contracts gestisce le funzionalità non supportate da Azure API Management durante l'esportazione di una definizione e cosa accade in Azure API Management quando si importa la definizione.
| Funzionalità OpenAPI non supportata | Contratti API comportamento all'esportazione | Comportamento di Azure API Management durante l'importazione |
|---|---|---|
| I parametri obbligatori tra percorsi e query devono avere nomi univoci. | Viene visualizzato un messaggio di errore. | L'importazione non riesce. |