Aracılığıyla paylaş


Veri API oluşturucusu için ilkeler

Hataya neden olan değişiklikler, bildirimler, sürümler ve sürüm oluşturma ile ilgili Veri API'sinin oluşturucusu ilke kümesi tarafından yönetilir.

Sürüm oluşturma ve sürümler

A release in the context of Data API builder refers to every published version of the software, identified by the Major.Minor.Patch format. These releases fall into three categories: stable, breaking change, and preview.

Kapsayıcı Güncelleştirme Sorumluluğu

Veri API oluşturucu kapsayıcısı otomatik olarak güncelleştirilmez. Müşteriler yeni sürümleri izlemek, önemlerini değerlendirmek (güvenlik güncelleştirmeleri dahil) ve dağıtılan kapsayıcıları uygun şekilde güncelleştirmekle sorumludur.

Keeping the container up to date is the customer’s responsibility.

Stable releases

A stable version of Data API builder is backwards compatible. Geriye dönük uyumlu, veri API oluşturucusunun bir sürümüne dayalı olarak yazdığınız tüm kodların, doğruluğu veya mevcut işlevselliği korumak için herhangi bir kod değişikliği gerektirmeden daha yeni ve kararlı bir sürümü benimseyebileceği anlamına gelir.

Hataya neden olan değişiklik sürümleri

Veri API oluşturucusunun hataya neden olan bir değişiklik sürümü geriye dönük olarak uyumlu değildir. Mevcut istemci kodunda hataya neden olan bir değişiklik sürümünü benimsemek, istemcinin önceki sürümü hedeflerken olduğu gibi davrandığından emin olmak için kod değişiklikleri gerektirebilir.

Hataya neden olan değişiklik sürümleri, hataya neden olan değişiklik listesi makalesi aracılığıyla ve GitHub sürümünün değişiklik açıklamasında duyurulur. Değişiklikler kritik güvenlik, gizlilik veya yasal sorunları düzeltmediği sürece, önizleme/sürüm adayı sürümünün yayımlanması hataya neden olan değişiklik sürümlerinden önce geliyor. Data API builder'ın önceki sürümleri GitHub sürümleri sayfasında kullanılabilir durumda kalabilir ancak hata düzeltmeleri içerebilecek en son sürüme yükseltmenizi öneririz.

Preview releases

Veri API'sinin oluşturucu önizleme sürümleri sürüm oluşturma düzeniyle X.Y.Z-rc tanımlanır. Sonek, -rc derlemenin bir "yayın adayı" olduğunu gösterir. Önizleme sürümleri, yeni özellikler ve diğer değişiklikler hakkında geri bildirim toplamak için kullanılır.

Son kararlı sürümden önemli değişiklikler yapmayı planlamadığımız sürece, en son kararlı sürüm ve yeni önizleme özellikleriyle birlikte sonraki önizleme sürümünü yayımlarız. Sonraki Veri API'sinin oluşturucusu güncelleştirmesi, önizleme sürümleri arasına eklediğimiz yeni önizleme özelliklerinden bazılarını bozabilir. Bu hataya neden olan davranış, işlerin yeniden çalışması için kodunuzu değiştirmeniz gerekebileceği anlamına gelir.

Önizleme sürümleri uzun süreli veya üretim amaçlı kullanım için tasarlanmamıştır. Yeni bir kararlı veya önizleme sürümü kullanıma sunulduğunda, eski önizleme sürümlerine artık erişilemiyor olabilir. Önizleme sürümlerini yalnızca yeni özellikler üzerinde etkin bir şekilde çalışırken ve yayından kısa süre sonra önizleme olmayan bir sürüme geçmeye hazır olduğunuzda kullanmak en iyisidir. Önizleme sürümündeki bazı özellikler yeni kararlı bir sürüme dahil edilirse, denemeniz için kalan önizleme özellikleri yeni bir önizleme sürümüne eklenir.

Sürüm değiştirme tablosu

Important

Değişiklik kritik ürün hatalarını, yasal, güvenlik veya gizlilik sorunlarını giderdiğinde küçük veya düzeltme eki yayınlarında hataya neden olan bir değişiklik gösterebiliriz.

Release type Previous Version New Version Notes
Breaking Change 1.Y.Z 2.Y.Z Yeni özellikler ve hata düzeltmelerinin yanı sıra hataya neden olan değişiklikler.
Stable 1.1.Z 1.2.Z Değişiklikler kritik ürün hatalarına, yasal, güvenlik veya gizlilik sorunlarına çözüm bulmadığı sürece hataya neden olmayan yeni özellikler ve hata düzeltmeleri.
Stable 1.1.1 1.1.2 Değişiklikler kritik ürün hatalarına, yasal, güvenlik veya gizlilik sorunlarına çözüm bulmadığı sürece yeni özellik içermeyen hata düzeltmeleri veya hataya neden olan değişiklikler.
Preview X.Y.1-rc X.Y.2-rc Yeni önizleme özellikleri ve hata düzeltmeleri. (Ana sürüme çarpıldığında hataya neden olan değişiklikler dahil edilir.)

Breaking Changes

Güvenliği önceliklendirmek, özellikleri geliştirmek ve kod kalitesini korumak için yazılımımızın yeni sürümleri hataya neden olan değişiklikleri içerebilir. Dikkatli mimari seçimlerle bu değişiklikleri en aza indirmeye çalışırken bunlar yine de gerçekleşebilir. Bu gibi durumlarda bunları duyurmayı ve olası çözümleri sağlamayı öncelikli hale getiririz.

Important

Değişikliğin hataya neden olmadığı kabul edilirse veya kritik ürün hatalarını ya da yasal, güvenlik veya gizlilik endişelerini gidermek için yapılan bir hata değişikliğiyse önceden bildirimde bulunmaksızın değişiklikler yapabilirsiniz.

Hataya neden olan değişiklik nedir?

Hataya neden olan değişiklik, kesintileri önlemek için uygulamanızı güncelleştirmenizi gerektiren bir değişikliktir. Veri API'si oluşturucusunda hataya neden olan değişiklikler REST API sözleşmelerinde, GraphQL şema oluşturmada ve uyumluluk ve işlevselliği etkileyen diğer öğelerde yapılan değişiklikleri içerebilir.

Hataya neden olan değişiklik örnekleri

The following examples are a nonexhaustive list of breaking changes to Data API builder:

  • REST API sözleşme değişiklikleri
  • GraphQL şema oluşturmada değişiklikler
  • Geriye dönük uyumluluğu etkileyen değişiklikler
  • API'leri veya parametreleri kaldırma veya yeniden adlandırma
  • Hata kodlarındaki değişiklikler
  • İzin tanımı işlevselliğinde yapılan ayarlamalar
  • İzin verilen parametrelerin, istek alanlarının veya yanıt alanlarının kaldırılması
  • Varsayılan değerler olmadan zorunlu parametrelerin veya istek alanlarının eklenmesi
  • Hedeflenen API uç noktası işlevselliğinde yapılan değişiklikler

Bölünemez değişikliğin tanımı

A non-breaking change refers to a change that can be integrated into your application without causing disruption. Bölünemez değişiklikler genellikle uygulamadan sonra iletilir. Uygulamanız önceden bildirimde bulunmaksızın bu değişiklikleri işleyecek şekilde tasarlanmalıdır.

Hataya Neden Olmayan Değişiklik Örnekleri

The following examples are a nonexhaustive list of nonbreaking changes to Data API builder:

  • Yeni uç noktalara giriş
  • Mevcut uç noktalara yöntem ekleme
  • Yanıtlara ve isteklere yeni alanların dahili
  • Yanıtlar içindeki alan düzeninde yapılan ayarlamalar
  • İsteğe bağlı istek üst bilgilerine giriş
  • Veri uzunluğu ve yanıt boyutu değişiklikleri
  • Hata iletilerinde ve kodlarında değişiklikler
  • HTTP yanıt kodlarına düzeltmeler
  • Oluşturulan OpenAPI belgelerinde ek meta veriler

Hataya neden olan değişiklikleri nasıl ileteceğiz?

Hataya neden olan değişiklikler hakkında sizi hemen bilgilendirmeyi öncelikli hale getiririz. Hataya neden olan değişiklik bildirimlerini GitHub'daki Data API builder sürümlerinin sürüm notlarında bulabilirsiniz.

Geçerli hataya neden olan değişiklik listesi

Hataya neden olan değişiklikler ve özellik kullanımdan kaldırma işlemleri bu makalede duyurulur.

  • Şu andan itibaren hataya neden olan bir değişiklik yoktur