API ağ geçidi uyumluluk modu
Son güncelleme: 20.10.2026API Contracts, 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, seçilen ağ geçidine başarıyla içe aktarılabilmesi için API Sözleşmeleri tanımınızı değiştirebilir.
Bazı durumlarda herhangi bir değişiklik yapılmaz, ancak dışa aktardığınız tanımla karşılaşabileceğiniz uyumluluk sorunu hakkında sizi bilgilendirmek için bir ileti görüntülenir.
AWS API Gateway için OAS 3.0 tanımını dışa aktarma
Aşağıdaki tabloda, bir tanım dışa aktarılırken API Contracts'ın AWS API Gateway tarafından desteklenmeyen özellikleri nasıl ele aldığı ve tanımı içe aktardığınızda AWS API Gateway'de nelerin gerçekleştiği açıklanmaktadır.
| Desteklenmeyen OpenAPI özelliği | API Sözleşmeleri dışa aktarma sırasındaki 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 bilgilendirme 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 bilgilendirme iletisi 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ıtlardaki ilkel veri türleri desteklenmez. | İlkel tür bir bileşen şeması içine sarmalanır ve bir uyarı mesajı görüntülenir. | İçe aktarma başarılı. |
| Medya türü aralıkları desteklenmez. | İstek veya yanıt korunur ve bir bilgilendirme iletisi 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 bilgilendirme mesajı görüntülenir. | İçe aktarma başarısız olur ve bir uyarı mesajı görüntülenir. |
| Aralık yanıtları desteklenmez. | Yanıt korunur ve bir bilgilendirme 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 üstbilgiler 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 tabloda, bir tanım dışa aktarılırken Azure API Management tarafından desteklenmeyen özelliklerin API Contracts tarafından nasıl ele alındığı ve tanımı içe aktardığınızda Azure API Management'ta nelerin gerçekleştiği açıklanmaktadır.
| Desteklenmeyen OpenAPI özelliği | API Sözleşmeleri dışa aktarma sırasındaki davranış | İçeri aktarma sırasında Azure API Management davranışı |
|---|---|---|
| Hem yollardaki hem de sorgulardaki zorunlu parametreler benzersiz adlara sahip olmalıdır. | Bir hata mesajı görüntülenir. | İçe aktarma başarısız olur. |