# API-gateway-compatibiliteitsmodus

API Contracts biedt een compatibiliteitsmodus voor API-gateways om u te helpen uw definitie te importeren in AWS API Gateway en Azure API Management.

Wanneer u uw API exporteert in een gateway-compatibiliteitsmodus, kan API Contracts uw definitie wijzigen zodat deze succesvol kan worden geïmporteerd in de geselecteerde gateway.

In sommige gevallen zijn er geen wijzigingen, maar wordt er een bericht weergegeven om u te informeren over het compatibiliteitsprobleem dat u kunt ondervinden met de definitie die u hebt geëxporteerd.

## Een OAS 3.0-definitie exporteren voor AWS API Gateway

In de volgende tabel wordt beschreven hoe API Contracts omgaat met functies die niet worden ondersteund door AWS API Gateway bij het exporteren van een definitie, en wat er in AWS API Gateway gebeurt wanneer u de definitie importeert.

| Niet-ondersteunde OpenAPI-functie | API-contracten<br>gedrag bij exporteren | Gedrag van AWS API Gateway bij import |
| --- | --- | --- |
| Het attribuut example wordt niet<br>ondersteund. | Het attribuut blijft behouden. | Het attribuut is verwijderd uit het schema. |
| Het attribuut readOnly wordt niet<br>ondersteund. | Het attribuut blijft behouden. | Het attribuut is verwijderd uit het schema. |
| Het attribuut additionalProperties<br>wordt niet ondersteund. | Het attribuut wordt behouden en er wordt een informatiebericht<br>weergegeven. | Er wordt een waarschuwingsbericht weergegeven, maar dit kan worden genegeerd en de definitie kan<br>succesvol worden geïmporteerd. |
| Typen beveiligingsdefinities:<br><br><ul><li><span>oauth2</span> wordt niet ondersteund,</li><li><span>http</span> wordt niet ondersteund,</li><li><span>openIdConnect</span> wordt niet ondersteund.</li></ul> | De beveiligingsschema's worden behouden en er wordt een informatiebericht<br>weergegeven. | Er wordt een waarschuwingsbericht weergegeven, maar dit kan worden genegeerd en de definitie kan<br>succesvol worden geïmporteerd. |
| Primitieve gegevenstypen in antwoorden worden niet ondersteund. | Het primitieve type wordt verpakt in een componentschema en er wordt een waarschuwingsbericht<br>weergegeven. | Het importeren slaagt. |
| Media-type-bereiken worden niet ondersteund. | Het verzoek of het antwoord blijft behouden en er wordt een informatiebericht<br>weergegeven. | De import mislukt en er wordt een waarschuwing weergegeven. |
| Standaardantwoord wordt niet ondersteund. | De respons wordt behouden en er wordt een informatiebericht weergegeven. | De import mislukt en er wordt een waarschuwing weergegeven. |
| Bereikantwoorden worden niet ondersteund. | De respons wordt behouden en er wordt een informatiebericht weergegeven. | De import mislukt en er wordt een waarschuwing weergegeven. |
| Padvariabelen, queryparameters en headers moeten unieke namen hebben. | De parameters blijven behouden en er wordt een foutmelding weergegeven. | De import mislukt. |

## Een OAS/Swagger 2.0-definitie exporteren voor Azure API Management

In de volgende tabel wordt beschreven hoe API Contracts omgaat met de functies die niet worden ondersteund door Azure API Management bij het exporteren van een definitie, en wat er in Azure API Management gebeurt wanneer u de definitie importeert.

| Niet-ondersteunde OpenAPI-functie | API-contracten<br>gedrag bij exporteren | Gedrag van Azure API Management bij importeren |
| --- | --- | --- |
| Vereiste parameters voor zowel paden als query's moeten unieke<br>namen hebben. | Een foutmelding wordt weergegeven. | De import mislukt. |