API-gateway compatibiliteitsmodus
API Designer biedt een API-gateway compatibiliteitsmodus om u te helpen uw definitie te importeren in AWS API Gateway en Azure API Management.
Bij het exporteren van uw API in een gateway-compatibiliteitsmodus kan API Designer 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 mogelijk ondervindt met de definitie die u hebt geëxporteerd.
Een OAS 3.0-definitie exporteren voor AWS API Gateway
De volgende tabel beschrijft hoe API Designer omgaat met de functies die niet worden ondersteund door AWS API Gateway bij het exporteren van een definitie, en wat er gebeurt in AWS API Gateway wanneer u de definitie importeert.
| Niet-ondersteunde OpenAPI-functie | API Designer-gedrag bij exporteren | AWS API Gateway-gedrag bij importeren |
|---|---|---|
| Het example-attribuut wordt niet ondersteund. | Het attribuut blijft behouden. | Het attribuut wordt uit het schema verwijderd. |
| Het readOnly-attribuut wordt niet ondersteund. | Het attribuut blijft behouden. | Het attribuut wordt uit het schema verwijderd. |
| Het additionalProperties-attribuut wordt niet ondersteund. | Het attribuut blijft behouden en er wordt een informatiemelding weergegeven. | Er wordt een waarschuwingsmelding weergegeven, maar deze kan worden genegeerd en de definitie kan succesvol worden geïmporteerd. |
Typen beveiligingsdefinities:
|
De beveiligingsschema's blijven behouden en er wordt een informatiemelding weergegeven. | Er wordt een waarschuwingsmelding weergegeven, maar deze kan worden genegeerd en de definitie kan succesvol worden geïmporteerd. |
| Primitieve gegevenstypen in antwoorden worden niet ondersteund. | Het primitieve type wordt verpakt in een componentschema en er wordt een waarschuwingsmelding weergegeven. | De import slaagt. |
| Mediatypebereiken worden niet ondersteund. | Het verzoek of antwoord blijft behouden en er wordt een informatiemelding weergegeven. | De import mislukt en er wordt een waarschuwingsmelding weergegeven. |
| Standaardantwoord wordt niet ondersteund. | Het antwoord blijft behouden en er wordt een informatiemelding weergegeven. | De import mislukt en er wordt een waarschuwingsmelding weergegeven. |
| Bereikantwoorden worden niet ondersteund. | Het antwoord blijft behouden en er wordt een informatiemelding weergegeven. | De import mislukt en er wordt een waarschuwingsmelding 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
De volgende tabel beschrijft hoe API Designer omgaat met de functies die niet worden ondersteund door Azure API Management bij het exporteren van een definitie, en wat er gebeurt in Azure API Management wanneer u de definitie importeert.
| Niet-ondersteunde OpenAPI-functie | API Designer-gedrag bij exporteren | Azure API Management-gedrag bij importeren |
|---|---|---|
| Vereiste parameters in zowel paden als query's moeten unieke namen hebben. | Er wordt een foutmelding weergegeven. | De import mislukt. |