Hataya neden olmayan değişiklikleri güvenli bir şekilde yapmak için düzeltmeleri kullanmaUse revisions to make non-breaking changes safely

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.When your API is ready to go and starts to be used by developers, you eventually need to make changes to that API and at the same time not disrupt callers of your API. Yaptığınız değişiklikleri geliştiricilere bildirmeniz de yararlıdır.It's also useful to let developers know about the changes you made. Azure API Management’da düzeltmeleri kullanarak bunu yapabilirsiniz.We can do this in Azure API Management using revisions. Daha fazla bilgi için bkz. Sürümler ve revizyonlar ve Azure API Management ile API Sürümü Oluşturma.For more information, see Versions & revisions and API Versioning with Azure API Management.

Bu öğreticide şunların nasıl yapıldığını öğreneceksiniz:In this tutorial, you learn how to:

  • Yeni düzeltme eklemeAdd a new revision
  • Düzeltmenizde hataya neden olmayan değişiklikler yapmaMake non-breaking changes to your revision
  • Düzeltmenizi geçerli hale getirme ve bir değişiklik günlüğü girdisi eklemeMake your revision current and add a change log entry
  • Değişiklikleri ve değişiklik günlüğünü görmek için geliştirici portalına göz atmaBrowse the developer portal to see changes and change log

Geliştirici Portalında Değişiklik Günlüğü

ÖnkoşullarPrerequisites

Yeni düzeltme eklemeAdd a new revision

API düzeltmesi ekleme

  1. API’ler sayfasını seçin.Select APIs page.

  2. API listesinden Tanıtım Konferans API’sini (veya düzeltme eklemek istediğiniz diğer API’yi) seçin.Select Demo Conference API from the API list (or other API to which you want to add revisions).

  3. Sayfanın üst kısmındaki menüden Düzeltmeler sekmesine tıklayın.Click the Revisions tab from the menu near the top of the page.

  4. + Düzeltme Ekle’yi seçinSelect + Add Revision

    İpucu

    Ayrıca API’nin açılır menüsünden ( ... ) Düzeltme Ekle’yi seçebilirsiniz.You can also choose Add Revision in the context menu (...) of the API.

  5. Ne için kullanılacağını hatırlamaya yardımcı olmak için revizyonunuza ilişkin bir açıklama ekleyin.Provide a description for your new revision, to help remember what it will be used for.

  6. Oluştur’u seçinSelect Create

  7. Yeni bir düzeltme oluşturulur.Your new revision is now created.

    Not

    Özgün API'niz Düzeltme 1’de kalır.Your original API remains in Revision 1. Farklı bir düzeltmeyi güncel yapana kadar kullanıcılarınız bu düzeltmeyi çağırmaya devam eder.This is the revision your users continue to call, until you choose to make a different revision current.

Düzeltmenizde hataya neden olmayan değişiklikler yapmaMake non-breaking changes to your revision

Düzeltmeyi değiştirme

  1. API listesinden Tanıtım Konferans API’sini seçin.Select Demo Conference API from the API list.

  2. Ekranın üst kısmında Tasarım sekmesini seçin.Select the Design tab near the top of the screen.

  3. Düzeltme seçici’nin (tasarım sekmesinin hemen üzerinde) Düzeltme 2’nin seçildiğini gösterdiğinden emin olun.Notice that the revision selector (directly above the design tab) shows Revision 2 as currently selected.

    İpucu

    Üzerinde çalışmak istediğiniz düzeltmeler arasında geçiş yapmak için düzeltme seçiciyi kullanın.Use the revision selector to switch between revisions that you wish to work on.

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

  5. Yeni işleminizi POST olarak, işlemin Adını, Görünen Adını ve URL'sini ise test olarak ayarlayın.Set your new operation to be POST, and the Name, Display Name and URL of the operation as test.

  6. Yeni işleminizi kaydedin.Save your new operation.

  7. Düzeltme 2’de bir değişiklik yapmış olduk.We have now made a change to Revision 2. Düzeltme 1’e geri dönmek için sayfanın üst kısmındaki Düzeltme Seçici’yi kullanın.Use the Revision Selector near the top of the page to switch back to Revision 1.

  8. Yeni işleminizin Düzeltme 1’de görünmediğine dikkat edin.Notice that your new operation does not appear in Revision 1.

Düzeltmenizi geçerli hale getirme ve bir değişiklik günlüğü girdisi eklemeMake your revision current and add a change log entry

  1. Sayfanın üst kısmındaki menüden Düzeltmeler sekmesini seçin.Select the Revisions tab from the menu near the top of the page.

    Düzeltme ekranındaki düzeltme menüsü.

  2. Düzeltme 2’nin açılır menüsünü ( ... ) açın.Open the context menu (...) for Revision 2.

  3. Geçerli Hale Getir’i seçin.Select Make Current.

  4. Bu değişiklik hakkında notlar yayınlamak istiyorsanız Bu API için Genel Değişiklik Günlüğüne Gönder’i işaretleyin.Check Post to Public Change log for this API, if you want to post notes about this change. Geliştiriciler bakın, örneğin, bir değişiklik için bir açıklama sağlayın: Test düzeltmeleri. Yeni "test" işlemi eklendi.Provide a description for your change that developers see, for example: Testing revisions. Added new "test" operation.

  5. Düzeltme 2 artık geçerlidir.Revision 2 is now current.

Değişiklikleri ve değişiklik günlüğünü görmek için geliştirici portalına göz atmaBrowse the developer portal to see changes and change log

  1. Azure portalda API’ler öğesini seçin.In the Azure portal, select APIs.

  2. Üstteki menüden Geliştirici Portalı’nı seçin.Select Developer Portal from the top menu.

  3. API'ler ve ardından Tanıtım Konferans API’si öğesini seçin.Select APIs, and then select Demo Conference API.

  4. Yeni test işleminizin artık kullanılabilir olduğuna dikkat edin.Notice your new test operation is now available.

  5. API adının altından API Değişiklik Geçmişi’ni seçin.Select API Change History from below the API name.

  6. Değişiklik günlüğü girdinizin bu listede göründüğüne dikkat edin.Notice that your change log entry appears in this list.

    Geliştirici portalı

Sonraki adımlarNext steps

Bu öğreticide, şunların nasıl yapıldığını öğrendiniz:In this tutorial, you learned how to:

  • Yeni düzeltme eklemeAdd a new revision
  • Düzeltmenizde hataya neden olmayan değişiklikler yapmaMake non-breaking changes to your revision
  • Düzeltmenizi geçerli hale getirme ve bir değişiklik günlüğü girdisi eklemeMake your revision current and add a change log entry
  • Değişiklikleri ve değişiklik günlüğünü görmek için geliştirici portalına göz atmaBrowse the developer portal to see changes and change log

Sonraki öğreticiye ilerleyin:Advance to the next tutorial: