Öğretici: Bölünemez API değişikliklerini güvenli bir şekilde yapmak için düzeltmeleri kullanma

UYGULANANLAR: Tüm API Management katmanları

API'niz geliştiriciler tarafından kullanıldığında, API'nizi çağıranları kesintiye uğratmadan bu API'de bir değişiklik yapmanız gerekir. Yaptığınız değişiklikleri geliştiricilere bildirmeniz de yararlıdır.

Azure API Management'ta, bölünemez API değişiklikleri yapmak için düzeltmeleri kullanın. Değişiklikleri güvenle modelleyebilir ve test edebilirsiniz. Hazır olduğunuzda düzeltmenizi güncel hale getirin ve geçerli API'yi değiştirin.

Daha fazla bilgi için bkz . Sürümler ve Düzeltmeler.

İpucu

API ekipleri bu özelliği çalışma alanlarında kullanabilir. Çalışma alanları, API'lere ve kendi API çalışma zamanı ortamlarına yalıtılmış yönetim erişimi sağlar.

Bu öğreticide aşağıdakilerin nasıl yapılacağını öğreneceksiniz:

• Yeni düzeltme ekleme
• Düzeltmenizde bölünemez 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
• API düzeltmeye erişme

Önkoşullar

• Azure API Management terminolojisini öğrenin.
• Şu hızlı başlangıcı tamamlayın: Azure API Management örneği oluşturma.
• Aşağıdaki öğreticiyi tamamlayın: İlk API'nizi içeri aktarın ve yayımlayın.

Yeni düzeltme ekleme

1. Azure portalında oturum açın ve API Management örneğine gidin.

2. Soldaki menüde, API'ler'in altında API'ler'i seçin.

3. API listesinden Swagger Petstore'yı veya düzeltme eklemek istediğiniz farklı bir API'yi seçin.

4. Düzeltmeler sekmesini seçin.

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

   

   İpucu

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

6. Ne için kullanıldığını hatırlamaya yardımcı olmak için yeni düzeltmeniz için bir açıklama sağlayın.

7. Oluştur'u belirleyin.

   Yeni bir düzeltme oluşturulur.

   Not

   Özgün API'niz Düzeltme 1’de kalır. Bu, siz farklı bir sürümü geçerli hale getirene kadar kullanıcılarınızın aradığı sürümdür.

Düzeltmenizde bölünemez değişiklikler yapma

1. API listesinden Swagger Petstore'yi seçin.

2. Ekranın üst kısmındaki Tasarım'ı seçin.

   Tasarım sekmesinin üzerindeki düzeltme seçici , şu anda seçili olan Düzeltme 2'yi gösterir.

   İpucu

   Üzerinde çalışmak istediğiniz düzeltmeler arasında geçiş yapmak için düzeltme seçiciyi kullanın.

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

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

5. Yeni işleminizi kaydedin.

   

   Şimdi Düzeltme 2'de bir değişiklik yaptınız.

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

Portal

1. Sayfanın üst kısmındaki menüden Düzeltmeler'i seçin.

2. Düzeltme 2’nin açılır menüsünü (... ) açın.

3. Geçerli yap'ı seçin.

4. Bu değişiklikle ilgili notlar göndermek istiyorsanız , bu API için Genel Değişiklik günlüğüne gönder'i 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.

   

Azure CLI

Azure CLI'yi kullanmaya başlamak için:

• Azure Cloud Shell'de Bash ortamını kullanın. Daha fazla bilgi için bkz. Azure Cloud Shell'i kullanmaya başlama.

  

• CLI başvuru komutlarını yerel olarak çalıştırmayı tercih ediyorsanız Azure CLI'yı yükleyin . Windows veya macOS üzerinde çalışıyorsanız Azure CLI’yi bir Docker kapsayıcısında çalıştırmayı değerlendirin. Daha fazla bilgi için bkz . Docker kapsayıcısında Azure CLI'yi çalıştırma.

  • Yerel yükleme kullanıyorsanız az login komutunu kullanarak Azure CLI ile oturum açın. Kimlik doğrulama işlemini tamamlamak için terminalinizde görüntülenen adımları izleyin. Diğer oturum açma seçenekleri için bkz. Azure CLI kullanarak Azure'da kimlik doğrulaması.

  • İstendiğinde, ilk kullanımda Azure CLI uzantısını yükleyin. Uzantılar hakkında daha fazla bilgi için bkz. Azure CLI ile uzantıları kullanma ve yönetme.

  • Yüklü sürümü ve bağımlı kitaplıkları bulmak için az version komutunu çalıştırın. En son sürüme yükseltmek için az upgrade komutunu çalıştırın.

Bir sürümü oluşturmak ve güncelleştirmek için bu yordamı kullanın.

1. API kimliklerinizi görmek için az api list komutunu çalıştırın:

   az apim api list --resource-group apim-hello-word-resource-group \
       --service-name apim-hello-world --output table
   

   Bir sonraki komutta kullanılacak API kimliği değeridir Name . API düzeltmesi sütundadır ApiRevision .

2. Yayını oluşturmak için, bir yayın notuyla az apim api release create komutunu çalıştırın:

   az apim api release create --resource-group apim-hello-word-resource-group \
       --api-id swagger-petstore --api-revision 2 --service-name apim-hello-world \
       --notes 'Testing revisions. Added new "test" operation.'
   

   Serbest bıraktığınız düzeltme geçerli düzeltmeye dönüşür.

3. Yayınlarınızı görmek için az apim api release list komutunu kullanın:

   az apim api release list --resource-group apim-hello-word-resource-group \
       --api-id swagger-petstore --service-name apim-hello-world --output table
   

   Belirttiğiniz notlar değişiklik günlüğünde görünür. Bunları önceki komutun çıkışında görebilirsiniz.

4. Bir yayın --notes oluşturduğunuzda parametresi isteğe bağlıdır. Notları daha sonra az apim api release update komutunu kullanarak ekleyebilir veya değiştirebilirsiniz:

   az apim api release update --resource-group apim-hello-word-resource-group \
       --api-id swagger-petstore --release-id 00000000000000000000000000000000 \
       --service-name apim-hello-world --notes "Revised notes."
   

   Yayın kimliği için sütundaki Name değeri kullanın.

az apim api release delete komutunu çalıştırarak herhangi bir sürümü kaldırabilirsiniz:

az apim api release delete --resource-group apim-hello-word-resource-group \
    --api-id swagger-petstore --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ı denerseniz API değişikliklerini gözden geçirebilir ve günlüğü burada değiştirebilirsiniz.

1. Azure portalında API Management örneğine gidin.
2. Soldaki menüde, API'ler'in altında API'ler'i seçin.
3. Üstteki menüden Geliştirici portalı'nı seçin.
4. Geliştirici portalında API'ler'i ve ardından Swagger Petstore'yı seçin.
5. Yeni test işleminizin artık kullanılabilir olduğuna dikkat edin.
6. API adının yanındaki Değişiklik Günlüğü'nü seçin.
7. Değişiklik günlüğü girdinizin listede göründüğüne dikkat edin.

API düzeltmeye erişme

API'nizdeki her düzeltmeye özel olarak biçimlendirilmiş bir URL kullanılarak erişilebilir. BU API'nin belirli bir düzeltmesine erişmek için API URL yolunuzun sonuna, ancak sorgu dizesinden önce ekleyin ;rev={revisionNumber} . Örneğin, Swagger Petstore API'sinin 2. düzeltmesine erişmek için aşağıdakine benzer bir URL kullanabilirsiniz:

https://apim-hello-world.azure-api.net/store/pet/1;rev=2/

API'nizin düzeltmelerinin URL yollarını Azure portalındaki Düzeltmeler sekmesinde bulabilirsiniz.

İpucu

API yolunun sonuna eklenen tam URL'ye ek olarak, dize olmadan ;rev API yolunu kullanarak API'nizin geçerli;rev={revisionNumber}.

Özet

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

• Yeni düzeltme ekleme
• Düzeltmenizde bölünemez 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
• API düzeltmeye erişme

Sonraki adım

Sonraki öğreticiye ilerleyin:

API'nizin birden fazla sürümünü yayımlama