Öğretici: Hataya neden olmayan API değişikliklerini güvenli bir şekilde yapmak için düzeltmeleri kullanma

API’niz kullanıma hazır olduğunda ve geliştiriciler tarafından kullanılmaya başladığında genellikle bu API’de değişiklikler yapmak ve aynı zamanda API’nizi çağıranları kesintiye uğratmamak istersiniz. Yaptığınız değişiklikleri geliştiricilere bildirmeniz de yararlıdır.

Azure API Management'de, değişiklikleri güvenli bir şekilde modellemek ve test etmek için hataya neden olmayan API değişiklikleri yapmak için düzeltmeleri kullanın. Hazır olduğunda, bir düzeltmeyi geçerli hale ve geçerli API'nizi değiştirebilirsiniz.

Arka plan için bkz. & sürümleri ve Azure ile API Sürümü API Management.

Bu öğreticide şunların nasıl yapıldığını öğreneceksiniz:

Ö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

1. Azure portal'daoturum API Management.

2. API’ler seçeneğini belirleyin.

3. API listesinden (veya düzeltme eklemek istediğiniz başka bir API'den) Tanıtım Konferansı API'sini seçin.

4. Düzeltmeler sekmesini seçin.

5. + Düzeltme ekle'yi seçin.

   

   İpucu

   API'nin bağlam menüsünde ( ... ) Düzeltme ekle'yi de seçebilirsiniz.

6. Ne için kullanılacağını hatırlamaya yardımcı olmak için revizyonunuza ilişkin bir açıklama ekleyin.

7. Oluştur'a,

8. 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

1. API listesinden Tanıtım Konferans API’sini seçin.

2. Ekranın üst kısmında Tasarım sekmesini seçin.

3. 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.

4. + İşlem Ekle’yi seçin.

5. Yeni işleminizi POST olarak, işlemin Adını, Görünen Adını ve URL'sini ise test olarak ayarlayın.

6. Yeni işleminizi kaydedin.

   

7. Düzeltme 2'de bir değişiklik yaptık. Düzeltme 1'e geri dönmek için sayfanın üst kısmında bulunan düzeltme seçiciyi kullanın.

8. Yeni işleminizin Düzeltme 1’de görünmediğine dikkat edin.

Düzeltmenizi geçerli hale getirme ve bir değişiklik günlüğü girdisi ekleme

az apim api release delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --release-id 00000000000000000000000000000000 
    --service-name apim-hello-world

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 APIdeğişikliklerini gözden geçirebilirsiniz ve günlüğü orada değiştirebilirsiniz.

1. Azure portalda API’ler öğesini seçin.
2. Üst menüden Geliştirici portalı'ı seçin.
3. Geliştirici portalında API'ler'i ve ardından Tanıtım Konferansı API'sini seçin.
4. Yeni test işleminizin artık kullanılabilir olduğuna dikkat edin.
5. API adının yakınındaki Changelog'u seçin.
6. Değişiklik günlüğü girdinizin bu listede göründüğüne dikkat edin.

Sonraki adımlar

Bu öğreticide, şunların nasıl yapıldığını öğrendiniz:

Sonraki öğreticiye ilerleyin: