Przekształcenia podczas eksportu
Podczas eksportowania definicji zaprojektowanej z wykorzystaniem cech API Designer do formatu, który ich nie obsługuje, definicja jest modyfikowana w celu dopasowania do formatu docelowego. W tym procesie tracona jest część wyrazistości.
Poniższa tabela opisuje modyfikacje wprowadzone w definicji API podczas eksportowania w jednej z następujących specyfikacji:
- OAS/Swagger 2.0
- Swagger 1.2
- RAML 1.0
| Nieobsługiwana cecha | Przekształcenie |
|---|---|
| Komponenty | Komponent jest kopiowany w każdym miejscu, w którym jest używany. |
| Zakresy odpowiedzi i odpowiedzi domyślne | Odpowiedź jest usuwana. |
| Uwierzytelnianie Bearer i OpenID Connect | Schemat zabezpieczeń jest usuwany. |
| Kombinacje allOf | Kombinacja jest zastępowana obiektem zawierającym wszystkie właściwości wszystkich użytych typów. |
| Kombinacje anyOf i oneOf | Kombinacja jest zastępowana pustym obiektem. |
| Wiele punktów końcowych | Pierwszy opublikowany punkt końcowy jest uwzględniany w definicji, pozostałe są ignorowane. |
Specyfikacja OpenAPI 3.0 obsługuje tylko adresy URL w polu Warunki korzystania z usługi. Podczas eksportowania definicji w OAS 3.0 to pole jest eksportowane tylko wtedy, gdy zawiera adres URL. Jeśli tak nie jest, pole Warunki korzystania z usługi jest ignorowane, aby zapewnić ważność definicji.