Kompatibilitetsläge för API-gateway
API Designer erbjuder ett kompatibilitetsläge för API-gateway för att hjälpa dig att importera din definition till AWS API Gateway och Azure API Management.
När du exporterar ditt API i ett kompatibilitetsläge för gateway kan API Designer ändra din definition så att den kan importeras till den valda gatewayen.
I vissa fall görs inga ändringar, men ett meddelande visas för att informera dig om det kompatibilitetsproblem som du kan stöta på med den definition du exporterade.
Exportera en OAS 3.0-definition för AWS API Gateway
Följande tabell beskriver hur API Designer hanterar de funktioner som inte stöds av AWS API Gateway när du exporterar en definition, och vad som händer i AWS API Gateway när du importerar definitionen.
| OpenAPI-funktion som inte stöds | Beteende för API Designer vid export | Beteende för AWS API Gateway vid import |
|---|---|---|
| Attributet example stöds inte. | Attributet bevaras. | Attributet tas bort från schemat. |
| Attributet readOnly stöds inte. | Attributet bevaras. | Attributet tas bort från schemat. |
| Attributet additionalProperties stöds inte. | Attributet bevaras och ett informationsmeddelande visas. | Ett varningsmeddelande visas men kan ignoreras och definitionen kan importeras. |
Typer av säkerhetsdefinitioner:
|
Säkerhetsschemana bevaras och ett informationsmeddelande visas. | Ett varningsmeddelande visas men kan ignoreras och definitionen kan importeras. |
| Primitiva datatyper i svar stöds inte. | Den primitiva typen omsluts i ett komponentschema och ett varningsmeddelande visas. | Importen lyckas. |
| Mediatypintervall stöds inte. | Begäran eller svaret bevaras och ett informationsmeddelande visas. | Importen misslyckas och ett varningsmeddelande visas. |
| Standardsvar stöds inte. | Svaret bevaras och ett informationsmeddelande visas. | Importen misslyckas och ett varningsmeddelande visas. |
| Intervallsvar stöds inte. | Svaret bevaras och ett informationsmeddelande visas. | Importen misslyckas och ett varningsmeddelande visas. |
| Sökvägsvariabler, frågeparametrar och rubriker måste ha unika namn. | Parametrarna bevaras och ett felmeddelande visas. | Importen misslyckas. |
Exportera en OAS/Swagger 2.0-definition för Azure API Management
Följande tabell beskriver hur API Designer hanterar de funktioner som inte stöds av Azure API Management när du exporterar en definition, och vad som händer i Azure API Management när du importerar definitionen.
| OpenAPI-funktion som inte stöds | Beteende för API Designer vid export | Beteende för Azure API Management vid import |
|---|---|---|
| Obligatoriska parametrar över både sökvägar och frågor måste ha unika namn. | Ett felmeddelande visas. | Importen misslyckas. |