API'nizin birden fazla sürümünü yayımlamaPublish multiple versions of your API

API’nizin tüm çağıranlarının tam olarak aynı sürümü kullanmasını sağlamak bazen kullanışlı olmayabilir.There are times when it is impractical to have all callers to your API use exactly the same version. Çağıranlar sonraki bir sürüme yükseltmek istediğinde, bunu anlaşılması kolay bir yaklaşımı kullanarak yapabilmek ister.When callers want to upgrade to a later version, they want to be able to do this using an easy to understand approach. Bunu Azure API Management’taki sürümleri kullanarak gerçekleştirmek mümkündür.It is possible to do this using versions in Azure API Management. Daha fazla bilgi için bkz. Sürümler ve düzeltmeler.For more information, see Versions & revisions.

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

  • Yeni bir sürümü mevcut bir API’ye eklemeAdd a new version to an existing API
  • Sürüm şeması seçmeChoose a version scheme
  • Sürümü bir ürüne eklemeAdd the version to a product
  • Sürümü görüntülemek için geliştirici portalına göz atmaBrowse the developer portal to see the version

Geliştirici portalında gösterilen sürüm

ÖnkoşullarPrerequisites

Yeni bir sürüm eklemeAdd a new version

API Bağlam menüsü - sürüm ekleme

  1. API listesinden Tanıtım Konferans API’sini seçin.Select Demo Conference API from the API list.
  2. Bunun yanındaki bağlam menüsünü ( ... ) seçin.Select the context menu (...) next to it.
  3. + Sürüm Ekle seçeneğini belirleyin.Select + Add Version.

İpucu

Sürümler yeni bir API’yi ilk kez oluşturduğunuzda da etkinleştirilebilir. Bunun için API Ekle ekranında Bu API’nin sürümü oluşturulsun mu? seçeneğini belirleyin.Versions can also be enabled when you first create a new API - select Version this API? on the Add API screen.

Sürüm oluşturma düzeni seçmeChoose a versioning scheme

Azure API Management, çağıranlara istedikleri API sürümünü belirtme olanağını nasıl sunacağınızı seçmenizi sağlar.Azure API Management allows you to choose the way in which you allow callers to specify which version of your API they want. Kullanılacak API sürümünü bir sürüm oluşturma düzeni seçerek belirtirsiniz.You specify which API version to use by selecting a versioning scheme. Bu düzen yol, üst bilgi veya sorgu dizesi olabilir.This scheme can be either path, header or query string. Aşağıdaki örnekte, sürüm oluşturma düzeni için yol kullanılmaktadır.In the following example, path is used to select the versioning scheme.

Sürüm ekle ekranı

  1. Sürüm oluşturma düzeniniz olarak yol seçeneğini belirlenmiş halde bırakın.Leave path selected as your versioning scheme.

  2. Ad alanına demo-conference-api-v1 yazın.Type demo-conference-api-v1 in the Name field.

    Not

    Sürüm aslında API'nin düzeltmesine dayanan yeni bir API'dir.Version is in fact a new API based off an API's revision. Ad, yeni API’nin adıdır ve API Management örneği genelinde benzersiz olmalıdır.Name is the new API's name and it must be unique across API Management instance.

  3. Sürüm tanımlayıcısı alanına v1 yazın.Type v1 in the Version identifier field.

    İpucu

    Sürüm oluşturma şeması olarak üst bilgi veya sorgu dizesi seçeneğini belirlerseniz üst bilgi veya sorgu dizesi parametresinin adı gibi bir ek değer belirtmeniz gerekir.If you select header or query string as a versioning scheme, you need to provide an additional value - the name of the header or query string parameter.

  4. Yeni sürümünüzü ayarlamak için Oluştur’u seçin.Select Create to set up your new version.

  5. API listesindeki Demo Konferans API’sinin altında artık iki ayrı API görürsünüz: Özgün ve v1.Underneath Demo Conference API in the API List, you now see two distinct APIs - Original, and v1.

    Azure portalında bir API altında listelenen sürümler

    Not

    Sürüm bilgisi olmayan bir API’ye sürüm eklerseniz, varsayılan URL’de yanıt veren bir Özgün sürüm otomatik olarak oluşturulur.If you add a version to a non-versioned API, an Original will be automatically created - responding on the default URL. Bu, mevcut çağıranların sürüm ekleme işleminden olumsuz yönde etkilenmemesini sağlar.This ensures that any existing callers are not broken by the process of adding a version. Başlangıçta etkinleştirilen sürümlerle yeni bir API oluşturursanız Özgün sürüm oluşturulmaz.If you create a new API with versions enabled at the start, an Original is not created.

  6. Artık Özgün sürümden ayrı bir API olarak v1 sürümünü düzenleyip yapılandırabilirsiniz.You can now edit and configure v1 as an API that is separate to Original. Bir sürümde yapılan değişiklikler diğer bir sürümü etkilemez.Changes to one version do not affect another.

Sürümü bir ürüne eklemeAdd the version to a product

Çağıranların yeni sürümü görmesi için sürümün ürüne eklenmesi gerekir.In order for callers to see the new version, it must be added to a product.

API Management Ürünleri

  1. Klasik dağıtım modeli sayfasından Ürünler seçeneğini belirleyin.Select Products from the classic deployment model page.
  2. Sınırsız’ı seçin.Select Unlimited.
  3. API’ler seçeneğini belirleyin.Select APIs.
  4. Add (Ekle) seçeneğini belirleyin.Select Add.
  5. Demo Konferans API’si, Sürüm v1 seçeneğini belirleyin.Select Demo Conference API, Version v1.
  6. Seç'e tıklayın.Click Select.

Sürümü görüntülemek için geliştirici portalına göz atmaBrowse the developer portal to see the version

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

  2. API'ler seçeneğini belirleyin. Demo Konferans API’sinin Özgün ve v1 sürümlerini gösterdiğine dikkat edin.Select APIs, notice that Demo Conference API shows Original and v1 versions.

  3. v1’i seçin.Select v1.

  4. Listedeki ilk işlemin İstek URL'sine dikkat edin.Notice the Request URL of the first operation in the list. Bu, API URL’si yolunun v1 içerdiğini gösterir.It shows that the API URL path includes v1.

    API Bağlam menüsü - sürüm ekleme

Sonraki adımlarNext steps

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

  • Yeni bir sürümü mevcut bir API’ye eklemeAdd a new version to an existing API
  • Sürüm şeması seçmeChoose a version scheme
  • Sürümü bir ürüne eklemeAdd the version to a product
  • Sürümü görüntülemek için geliştirici portalına göz atmaBrowse the developer portal to see the version

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