Öğretici: Hataya neden olmayan API değişikliklerini güvenli bir şekilde yapmak için düzeltmeleri kullanma
UYGULANANLAR: Tüm API Management katmanları
API'niz kullanıma hazır olduğunda ve geliştiriciler tarafından kullanıldığında, sonunda bu API'de değişiklikler yapmanız gerekir ve aynı zamanda API'nizin arayanlarını kesintiye uğratmazsınız. Yaptığınız değişiklikleri geliştiricilere bildirmeniz de yararlıdır.
Azure API Management'ta değişiklikleri güvenli bir şekilde modelleyip test edebilmeniz için düzeltmeleri kullanarak hataya neden olmayan API değişiklikleri yapın. Hazır olduğunuzda, geçerli bir düzeltme yapabilir ve geçerli API'nizi değiştirebilirsiniz.
Arka plan için bkz . Sürümler ve düzeltmeler ve Azure API Management ile API Sürümü Oluşturma.
Bu öğreticide aşağıdakilerin nasıl yapılacağını öğreneceksiniz:
- Yeni düzeltme ekleme
- Düzeltmenizde hataya neden olmayan değişiklikler yapma
- Düzeltmenizi geçerli hale getirme ve bir değişiklik günlüğü girdisi ekleme
- Değişiklikleri ve değişiklik günlüğünü görmek için geliştirici portalına göz atma
Önkoşullar
- Azure API Management terminolojisini öğrenin.
- Şu hızlı başlangıcı tamamlayın: Azure API Management örneği oluşturma.
- Ayrıca, şu öğreticiyi tamamlayın: İlk API'nizi içeri aktarma ve yayımlama.
Yeni düzeltme ekleme
Azure portalında oturum açın ve API Management örneğine gidin.
API’ler seçeneğini belirleyin.
API listesinden Tanıtım Konferansı API'sini (veya düzeltme eklemek istediğiniz başka bir API'yi) seçin.
Düzeltmeler sekmesini seçin.
+ Düzeltme ekle'yi seçin.
İpucu
API'nin bağlam menüsünden (...) Düzeltme ekle'yi de seçebilirsiniz.
Ne için kullanılacağını hatırlamaya yardımcı olmak için yeni düzeltmeniz için bir açıklama sağlayın.
Oluştur'u belirleyin.
Yeni bir düzeltme oluşturulur.
Not
Özgün API'niz Düzeltme 1’de kalır. Farklı bir düzeltmeyi güncel yapana kadar kullanıcılarınız bu düzeltmeyi çağırmaya devam eder.
Düzeltmenizde hataya neden olmayan değişiklikler yapma
API listesinden Tanıtım Konferans API’sini seçin.
Ekranın üst kısmında Tasarım sekmesini seçin.
Düzeltme seçici’nin (tasarım sekmesinin hemen üzerinde) Düzeltme 2’nin seçildiğini gösterdiğinden emin olun.
İpucu
Üzerinde çalışmak istediğiniz düzeltmeler arasında geçiş yapmak için düzeltme seçiciyi kullanın.
+ İşlem Ekle’yi seçin.
Yeni işleminizi POST olarak ve işlemin Adı, Görünen Adı ve URL'sini test olarak ayarlayın.
Yeni işleminizi kaydedin.
Şimdi Düzeltme 2'de bir değişiklik yaptınız. Düzeltme 1'e geri dönmek için sayfanın üst kısmındaki düzeltme seçiciyikullanın.
Yeni işleminizin Düzeltme 1'de görünmediğini göreceksiniz.
Düzeltmenizi geçerli hale getirme ve bir değişiklik günlüğü girdisi ekleme
Sayfanın üst kısmındaki menüden Düzeltmeler sekmesini seçin.
Düzeltme 2’nin açılır menüsünü (... ) açın.
Geçerli yap'ı seçin.
Bu değişiklikle ilgili notlar göndermek istiyorsanız, bu API için Genel Değişikliğe Gönder onay kutusunu seçin. Değişiklikleriniz için geliştiricilerin görebileceği bir açıklama sağlayın, örneğin: Düzeltmeleri test etme. Yeni "test" işlemi eklendi.
Düzeltme 2 artık geçerlidir.
Değişiklikleri ve değişiklik günlüğünü görmek için geliştirici portalına göz atma
Geliştirici portalını denediyseniz API değişikliklerini gözden geçirebilir ve günlüğü burada değiştirebilirsiniz.
- Azure portalda API’ler öğesini seçin.
- Üstteki menüden Geliştirici portalı'nı seçin.
- Geliştirici portalında API'ler'i ve ardından Tanıtım Konferansı API'si'ni seçin.
- Yeni test işleminizin artık kullanılabilir olduğuna dikkat edin.
- API adının yanındaki Changelog öğesini seçin.
- Değişiklik günlüğü girdinizin listede göründüğüne dikkat edin.
Sonraki adımlar
Bu öğreticide, şunların nasıl yapıldığını öğrendiniz:
- Yeni düzeltme ekleme
- Düzeltmenizde hataya neden olmayan değişiklikler yapma
- Düzeltmenizi geçerli hale getirme ve bir değişiklik günlüğü girdisi ekleme
- Değişiklikleri ve değişiklik günlüğünü görmek için geliştirici portalına göz atma
Sonraki öğreticiye ilerleyin:
Geri Bildirim
https://aka.ms/ContentUserFeedback.
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz.Gönderin ve geri bildirimi görüntüleyin