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

Makale
08/05/2024

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 modellemek ve test etmek üzere bölünemez API değişiklikleri yapmak için düzeltmeleri kullanı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.

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.
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.
Soldaki menüde, API'ler'in altında API'ler'i seçin.
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ıldığı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 bölünemez 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 Görünen adı, 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çiciyi kullanı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
Azure CLI

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.

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'de Bash için hızlı başlangıç.
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 ile oturum açma.
- İ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.
- 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.

API kimliklerinizi görmek için az apim 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 .

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 demo-conference-api --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.

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 echo-api --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.
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 demo-conference-api --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 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 API değişikliklerini gözden geçirebilir ve günlüğü burada değiştirebilirsiniz.

Azure portalında API Management örneğine gidin.
Soldaki menüde, API'ler'in altında API'ler'i 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.

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, Demo Konferans API'sinin düzeltme 2'sine erişmek için bu URL'yi kullanabilirsiniz:

https://apim-hello-world.azure-api.net/conf;rev=2/speakers

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

Portaldaki düzeltme URL'lerinin ekran görüntüsü.

İpucu

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

Ö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ımlar

Sonraki öğreticiye ilerleyin:

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

Aracılığıyla paylaş