API-gateway-kompatibilitetsläge
Senast uppdaterad: 2026-10-20API Contracts 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 gateway-kompatibilitetsläge kan API Contracts ändra din definition så att den kan importeras utan problem 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 definitionen du exporterade.
Exportera en OAS 3.0-definition för AWS API Gateway
Följande tabell beskriver hur API Contracts hanterar 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 | API-kontrakt beteende vid att exportera | 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 utan problem. |
Säkerhetsdefinitionstyper:
|
Säkerhetsschemana bevaras och ett informationsmeddelande visas. | Ett varningsmeddelande visas men kan ignoreras och definitionen kan importeras utan problem. |
| Primitiva datatyper i svar stöds inte. | Den primitiva typen kapslas in i ett komponentschema och ett varningsmeddelande visas. | Importen lyckas. |
| Medietypintervall 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 headers 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 Contracts hanterar de funktioner som inte stöds av Azure API Management vid export av en definition, och vad som händer i Azure API Management när du importerar definitionen.
| OpenAPI-funktion som inte stöds | API-kontrakt beteende vid att exportera | Azure API Management-beteende vid import |
|---|---|---|
| Obligatoriska parametrar i både sökvägar och frågor måste ha unika namn. | Ett felmeddelande visas. | Importen misslyckas. |