Not
Bu sayfaya erişim yetkilendirme gerektiriyor. Oturum açmayı veya dizinleri değiştirmeyi deneyebilirsiniz.
Bu sayfaya erişim yetkilendirme gerektiriyor. Dizinleri değiştirmeyi deneyebilirsiniz.
UYGULANANLAR: Tüm API Management katmanları
Tüm API tüketicilerinin aynı sürümü kullanmasının pratik olmadığı durumlar vardır. Tüketiciler daha yeni bir sürüme yükseltmeye hazır olduğunda basit ve anlaşılır bir yaklaşımı tercih ederler. Bu öğreticide gösterildiği gibi Azure API Management, bu gereksinimi karşılamak için birden çok API sürümünün gösterilmesini destekler.
Arka plan bilgileri 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 bir sürümü mevcut bir API’ye ekleme
- Sürüm şeması seçme
- Sürümü bir ürüne ekleme
- Geliştirici portalında sürümü görüntüleme
Önkoşullar
- Azure API Management terminolojisini öğrenin.
- Hızlı başlangıç Azure API Management örneği oluşturma adımını tamamlayın.
- İlk API'nizi içeri aktarma ve yayımlama öğreticisini tamamlayın.
Yeni bir sürüm ekleme
Kenar çubuğu menüsündeKI API'ler'in altında API'ler'i seçin.
API listesinde Swagger Petstore - OpenAPI 3.0 dosyasını bulun. Swagger Petstore - OpenAPI 3.0'ın yanındaki üç noktayı (...) ve ardından Sürüm ekle'yi seçin. Sonraki bölümde sonuçta elde edilen pencereye değerler ekleyeceksiniz.
İpucu
Yeni bir API oluşturduğunuzda sürümleri de etkinleştirebilirsiniz. API Ekle ekranında Bu API'nin sürümü mü? seçeneğini belirleyin.
Sürüm oluşturma düzeni seçme
API Management'ta, bir sürüm oluşturma düzeni seçerek çağıranların API sürümünü nasıl belirteceğini seçersiniz: Yol, Üst Bilgi veya Sorgu dizesi. Aşağıdaki örnekte, sürüm oluşturma düzeni olarak Path kullanılmıştır.
Sürüm olarak yeni API oluştur penceresinde aşağıdaki tabloda yer alan değerleri girin. Ardından oluştur'u seçerek sürümünüzü oluşturun.
| Ayar | Değer | Açıklama |
|---|---|---|
| Sürüm tanımlayıcısı | v1 | Sürümün şemaya özgü göstergesi. Yol için, API URL yolunun son eki. |
| Sürüm oluşturma düzeni | Yol | Çağıranların API sürümünü belirtme yöntemi. Üst Bilgi veya Sorgu dizesi'ni seçerseniz başka bir değer girin: üst bilgi veya sorgu dizesi parametresinin adı. Kullanım örneği görüntülenir. |
| Tam API sürüm adı | swagger-petstore-openapi-3-0-v1 | API Yönetimi örneğinizdeki benzersiz isim. Sürüm aslında API'nin düzeltmesini temel alan yeni bir API olduğundan, bu değer yeni API'nin adıdır. |
| Ürünler | Sınırsız (bazı hizmet katmanlarında sağlanır) | İsteğe bağlı olarak, API sürümünün ilişkili olduğu bir veya daha fazla ürün. API’yi yayımlamak için bir ürünle ilişkilendirmeniz gerekir. Sürümü daha sonra bir ürüne de ekleyebilirsiniz. |
Sürümü oluşturduktan sonra, API listesindeki Swagger Petstore - OpenAPI 3.0 altında görünür. Şimdi iki API görüyorsunuz: Özgün ve v1:
Not
Sürüm olmayan bir API'ye sürüm eklerseniz, özgün bir sürüm de otomatik olarak oluşturulur. Bu sürüm varsayılan URL'de yanıt verir. Özgün sürüm, sürüm eklendikten sonra mevcut arayanlardan gelen çağrıların çalışmaya devam etmesini sağlar. Başlangıçta sürümleri etkinleştirilmiş yeni bir API oluşturursanız özgün api oluşturulmaz.
Sürümü düzenleme
Sürümü ekledikten sonra, özgün sürümden ayrı bir API olarak düzenleyebilir ve yapılandırabilirsiniz. Bir sürümdeki değişiklikler başka bir sürümü etkilemez (örneğin, API işlemleri ekler veya kaldırırsanız ya da OpenAPI belirtimini düzenlerseniz). Daha fazla bilgi için bkz . API'yi düzenleme.
Sürümü bir ürüne ekleme
Arayanların yeni sürümü görebilmesi için bir ürüne eklenmesi gerekir. Sürümü henüz bir ürüne eklemediyseniz, bunu istediğiniz zaman yapabilirsiniz.
Sürümü bir ürüne eklemek için:
Azure portalında API Management örneğine gidin.
Kenar çubuğu menüsündeKI API'ler'in altında Ürünler'i seçin.
Ürünü ve ardından API'leri seçin.
+ Ekle'yi seçin.
API'yi seçin.
Seç'i seçin.
Sürüm kümelerini kullanma
Birden çok sürüm oluşturduğunuzda, Azure portalı tek bir mantıksal API için bir sürüm kümesini temsil eden bir sürüm kümesi oluşturur. Birden çok sürümü olan bir API'nin adını seçerseniz portal, api'nin sürüm kümesini görüntüler. Sürüm kümesinin adını ve açıklamasını özelleştirebilirsiniz.
Azure CLI'yi kullanarak sürüm kümeleriyle doğrudan etkileşim kurabilirsiniz:
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.
Tüm sürüm kümelerinizi görmek için az apim api versionset list komutunu çalıştırın:
az apim api versionset list --resource-group <resource-group-name> \
--service-name <API-management-service-name> --output table
Azure portalı sizin için bir sürüm kümesi oluşturduğunda, listenin Ad sütununda görünen alfasayısal bir ad atar. Bu adı diğer Azure CLI komutlarında kullanın.
Sürüm kümesiyle ilgili ayrıntıları görmek için az apim api versionset show komutunu çalıştırın:
az apim api versionset show --resource-group <resource-group-name> \
--service-name <API-management-service-name> --version-set-id <ID-from-the-name-column>
Sürüm kümeleri hakkında daha fazla bilgi için bkz . Azure API Management'taki sürümler.
Geliştirici portalında sürümü görüntüleme
Geliştirici portalını kullanıyorsanız API sürümlerini burada görebilirsiniz.
Pencerenin üst kısmındaki Geliştirici portalı'nı seçin.
API'ler'i ve ardından Swagger Petstore'yi seçin.
API adının yanında birden çok sürümü listeleyen bir açılan liste görmeniz gerekir.
v1’i seçin.
Listedeki ilk işlemin İstek URL'sine dikkat edin. Bu, API URL’si yolunun v1 içerdiğini gösterir.