API ağ geçidi uyumluluk modu
API Designer, tanımınızı AWS API Gateway ve Azure API Management'a içe aktarmanıza yardımcı olmak için bir API ağ geçidi uyumluluk modu sunar.
API'nizi bir ağ geçidi uyumluluk modunda dışa aktarırken, API Designer tanımınızı seçilen ağ geçidine başarıyla içe aktarılabilecek şekilde değiştirebilir.
Bazı durumlarda hiçbir değişiklik yapılmaz, ancak dışa aktardığınız tanımda karşılaşabileceğiniz uyumluluk sorunu hakkında sizi bilgilendirmek için bir mesaj görüntülenir.
AWS API Gateway için bir OAS 3.0 tanımını dışa aktarma
Aşağıdaki tablo, bir tanımı dışa aktarırken API Designer'ın AWS API Gateway tarafından desteklenmeyen özellikleri nasıl işlediğini ve tanımı içe aktardığınızda AWS API Gateway'de ne olduğunu açıklar.
| Desteklenmeyen OpenAPI özelliği | Dışa aktarma sırasında API Designer davranışı | İçe aktarma sırasında AWS API Gateway davranışı |
|---|---|---|
| example özniteliği desteklenmiyor. | Öznitelik korunur. | Öznitelik şemadan kaldırılır. |
| readOnly özniteliği desteklenmiyor. | Öznitelik korunur. | Öznitelik şemadan kaldırılır. |
| additionalProperties özniteliği desteklenmiyor. | Öznitelik korunur ve bir bilgi mesajı görüntülenir. | Bir uyarı mesajı görüntülenir ancak göz ardı edilebilir ve tanım başarıyla içe aktarılabilir. |
Güvenlik tanımı türleri:
|
Güvenlik şemaları korunur ve bir bilgi mesajı görüntülenir. | Bir uyarı mesajı görüntülenir ancak göz ardı edilebilir ve tanım başarıyla içe aktarılabilir. |
| Yanıtlar içindeki ilkel veri türleri desteklenmiyor. | İlkel tür bir bileşen şemasına sarılır ve bir uyarı mesajı görüntülenir. | İçe aktarma başarılı olur. |
| Medya türü aralıkları desteklenmiyor. | İstek veya yanıt korunur ve bir bilgi mesajı görüntülenir. | İçe aktarma başarısız olur ve bir uyarı mesajı görüntülenir. |
| Varsayılan yanıt desteklenmiyor. | Yanıt korunur ve bir bilgi mesajı görüntülenir. | İçe aktarma başarısız olur ve bir uyarı mesajı görüntülenir. |
| Aralık yanıtları desteklenmiyor. | Yanıt korunur ve bir bilgi mesajı görüntülenir. | İçe aktarma başarısız olur ve bir uyarı mesajı görüntülenir. |
| Yol değişkenleri, sorgu parametreleri ve başlıklar benzersiz adlara sahip olmalıdır. | Parametreler korunur ve bir hata mesajı görüntülenir. | İçe aktarma başarısız olur. |
Azure API Management için bir OAS/Swagger 2.0 tanımını dışa aktarma
Aşağıdaki tablo, bir tanımı dışa aktarırken API Designer'ın Azure API Management tarafından desteklenmeyen özellikleri nasıl işlediğini ve tanımı içe aktardığınızda Azure API Management'ta ne olduğunu açıklar.
| Desteklenmeyen OpenAPI özelliği | Dışa aktarma sırasında API Designer davranışı | İçe aktarma sırasında Azure API Management davranışı |
|---|---|---|
| Hem yollardaki hem de sorgulardaki gerekli parametreler benzersiz adlara sahip olmalıdır. | Bir hata mesajı görüntülenir. | İçe aktarma başarısız olur. |