Tryb zgodności bramy API
API Designer oferuje tryb zgodności bramy API, aby pomóc w importowaniu definicji do AWS API Gateway i Azure API Management.
Podczas eksportowania API w trybie zgodności bramy, API Designer może zmodyfikować definicję, aby można ją było pomyślnie zaimportować do wybranej bramy.
W niektórych przypadkach nie ma żadnych modyfikacji, ale wyświetlany jest komunikat informujący o problemie ze zgodnością, który można napotkać w przypadku wyeksportowanej definicji.
Eksportowanie definicji OAS 3.0 dla AWS API Gateway
Poniższa tabela opisuje, jak API Designer obsługuje cechy nieobsługiwane przez AWS API Gateway podczas eksportowania definicji, oraz co dzieje się w AWS API Gateway podczas importowania definicji.
| Nieobsługiwana cecha OpenAPI | Zachowanie API Designer podczas eksportu | Zachowanie AWS API Gateway podczas importu |
|---|---|---|
| Atrybut example nie jest obsługiwany. | Atrybut zostaje zachowany. | Atrybut zostaje usunięty ze schematu. |
| Atrybut readOnly nie jest obsługiwany. | Atrybut zostaje zachowany. | Atrybut zostaje usunięty ze schematu. |
| Atrybut additionalProperties nie jest obsługiwany. | Atrybut zostaje zachowany i wyświetlany jest komunikat informacyjny. | Wyświetlany jest komunikat ostrzegawczy, ale można go zignorować, a definicję można pomyślnie zaimportować. |
Typy definicji zabezpieczeń:
|
Schematy zabezpieczeń zostają zachowane i wyświetlany jest komunikat informacyjny. | Wyświetlany jest komunikat ostrzegawczy, ale można go zignorować, a definicję można pomyślnie zaimportować. |
| Prymitywne typy danych w odpowiedziach nie są obsługiwane. | Typ prymitywny jest opakowany w schemat komponentu i wyświetlany jest komunikat ostrzegawczy. | Import kończy się powodzeniem. |
| Zakresy typów mediów nie są obsługiwane. | Żądanie lub odpowiedź zostaje zachowana i wyświetlany jest komunikat informacyjny. | Import kończy się niepowodzeniem i wyświetlany jest komunikat ostrzegawczy. |
| Domyślna odpowiedź nie jest obsługiwana. | Odpowiedź zostaje zachowana i wyświetlany jest komunikat informacyjny. | Import kończy się niepowodzeniem i wyświetlany jest komunikat ostrzegawczy. |
| Odpowiedzi zakresowe nie są obsługiwane. | Odpowiedź zostaje zachowana i wyświetlany jest komunikat informacyjny. | Import kończy się niepowodzeniem i wyświetlany jest komunikat ostrzegawczy. |
| Zmienne ścieżki, parametry zapytania i nagłówki muszą mieć unikalne nazwy. | Parametry zostają zachowane i wyświetlany jest komunikat o błędzie. | Import kończy się niepowodzeniem. |
Eksportowanie definicji OAS/Swagger 2.0 dla Azure API Management
Poniższa tabela opisuje, jak API Designer obsługuje cechy nieobsługiwane przez Azure API Management podczas eksportowania definicji, oraz co dzieje się w Azure API Management podczas importowania definicji.
| Nieobsługiwana cecha OpenAPI | Zachowanie API Designer podczas eksportu | Zachowanie Azure API Management podczas importu |
|---|---|---|
| Wymagane parametry zarówno w ścieżkach, jak i zapytaniach muszą mieć unikalne nazwy. | Wyświetlany jest komunikat o błędzie. | Import kończy się niepowodzeniem. |