Azure API Management düzeltmeleri

  • Makale

UYGULANANLAR: Tüm API Management katmanları

Düzeltmeler, API'lerinizde denetimli ve güvenli bir şekilde değişiklik yapmanızı sağlar. Değişiklik yapmak istediğinizde yeni bir düzeltme oluşturun. Daha sonra API istemcilerinizde kesintiye neden olmadan API'yi düzenleyebilir ve test edebilirsiniz. Hazır olduğunuzda düzeltmenizi geçerli hale getirirsiniz. Aynı zamanda, API tüketicilerinizin değişiklerden haberdar olmasını sağlamak için isteğe bağlı olarak değişiklik günlüğüne bir giriş gönderebilirsiniz. Değişiklik günlüğü geliştirici portalınızda yayımlanır.

Not

Geliştirici portalı Tüketim katmanında kullanılamaz.

Düzeltmelerle:

  • Kasa üretim API'nizi rahatsız etmeden API tanımlarınızda ve ilkelerinizde değişiklik yapın.
  • Değişiklikleri yayımlamadan önce deneyin.
  • Geliştiricilerinizin yeni olanları anlaması için yaptığınız değişiklikleri belgeleyebilirsiniz.
  • Sorun bulursanız geri alın.

İzlenecek kılavuzu izleyerek düzeltmeleri kullanmaya başlayın.

Belirli düzeltmelere 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'nizin sonuna, ancak sorgu dizesinden önce ekleyin ;rev={revisionNumber} . Örneğin, API'nin 3. düzeltmesine erişmek için bu URL'yi customers kullanabilirsiniz:

https://apis.contoso.com/customers;rev=3/leads?customerId=123

Varsayılan olarak, her düzeltme geçerli düzeltmeyle aynı güvenlik ayarlarına sahiptir. Her düzeltme için farklı güvenlik uygulanmasını istiyorsanız, belirli bir düzeltmenin ilkelerini kasıtlı olarak değiştirebilirsiniz. Örneğin, dış arayanların hala geliştirme aşamasında olan bir düzeltmeye erişmesini önlemek için bir IP filtreleme ilkesi eklemek isteyebilirsiniz.

Not

;rev={id} URI yoluna değil API kimliğine eklenmelidir.

Geçerli düzeltme

Geçerli düzeltme olarak tek bir düzeltme ayarlanabilir. Bu düzeltme, URL'de açık bir düzeltme numarası belirtmeyen tüm API istekleri için kullanılan düzeltme olacaktır. Bu düzeltmeyi geçerli olarak ayarlayarak önceki bir düzeltmeye geri dönebilirsiniz.

Azure portalını kullanarak bir düzeltmeyi geçerli olarak ayarlayabilirsiniz. PowerShell kullanıyorsanız cmdlet'ini New-AzApiManagementApiRelease kullanabilirsiniz.

Düzeltme açıklamaları

Bir düzeltme oluşturduğunuzda, kendi izleme amaçlarınız için bir açıklama ayarlayabilirsiniz. Açıklamalar API kullanıcılarınıza görüntülenmez.

Bir düzeltmeyi geçerli olarak ayarladığınızda isteğe bağlı olarak bir genel değişiklik günlüğü notu da belirtebilirsiniz. Değişiklik günlüğü, API kullanıcılarınızın görüntülemesi için geliştirici portalına eklenir. PowerShell cmdlet'ini Update-AzApiManagementApiRelease kullanarak değişiklik günlüğü notunuzu değiştirebilirsiniz.

Dikkat

Bir API'nin geçerli olmayan bir düzeltmesini düzenliyorsanız, aşağıdaki özellikleri değiştiremezsiniz:

  • Ad
  • Tür
  • Description
  • Abonelik gerekiyor
  • API sürümü
  • API sürümü açıklaması
  • Yol
  • Protokoller

Bu özellikler yalnızca geçerli düzeltmede değiştirilebilir. Düzenlemeleriniz geçerli olmayan bir düzeltmenin yukarıdaki özelliklerinden herhangi birini değiştirirse, hata iletisi Can't change property for non-current revision görüntülenir.

Düzeltmeyi çevrimdışına alma

Düzeltme çevrimdışı duruma getirilebilir ve bu da düzeltmeye URL'si üzerinden erişmeye çalışsalar bile arayanlar tarafından erişilemez hale gelir. Azure portalını kullanarak bir düzeltmeyi çevrimdışı olarak işaretleyebilirsiniz.

Not

Düzeltmeleri test için kullanmadığınızda çevrimdışına almanızı öneririz.

Sürümler ve düzeltmeler

Sürümler ve düzeltmeler ayrı özelliklerdir. Her sürüm, aynı sürüme sahip olmayan BIR API gibi birden çok düzeltmeye sahip olabilir. Sürümleri kullanmadan veya başka bir yolla düzeltmeleri kullanabilirsiniz. Normalde sürümler, API sürümlerini hataya neden olan değişikliklerle ayırmak için kullanılırken, düzeltmeler api'de küçük ve hataya neden olmayan değişiklikler için kullanılabilir.

Düzeltmenizde hataya neden olan değişiklikler olduğunu fark ederseniz veya düzeltmenizi resmi olarak beta/test sürümüne dönüştürmek isterseniz, düzeltmeden bir sürüm oluşturabilirsiniz. Azure portalını kullanarak, Düzeltmeler sekmesindeki düzeltme bağlam menüsünde 'Düzeltmeden Sürüm Oluştur'a tıklayın.