Swagger ve OpenAPI Terimleri

Hiç yayınlanmayan bir önceki makaleyi yazarken, Swagger ve OpenAPI (OAS) terimleri arasındaki farkı pek çok kişinin anlamadığını fark ettim . İnsanlar her iki terimi de birbirinin yerine kullanır. Ben de aynı şüpheleri taşıdığım için onları suçlamıyorum.

Swagger, API'lerinizin yapısını makinelerin okuyabilmesi için tanımlamanıza olanak tanır.
— SwaggerIO

Google Swagger veya OpenAPI'yi denerseniz , çoğu durumda resmi Swagger web sitesi olan SwaggerIO'ya ulaşırsınız . Bana sorarsanız, web sitesi ilk günden beri Swagger'ın amacını gizledi. Yine de kasıtlı olarak değil. Bilgi eksik değil, sadece açık ve öz bir şekilde sunulmuyor.

OpenAPI Spesifikasyonu (OAS), hem insanların hem de bilgisayarların kaynak koduna, belgelere erişim olmadan veya ağ trafiği denetimi yoluyla hizmetin yeteneklerini keşfetmesine ve anlamasına olanak tanıyan, RESTful API'ler için standart bir dilden bağımsız arabirim tanımlar.
— SwaggerIO

Günümüzde bu konuyla ilgili birçok makale var, bu nedenle farkı anlamak çok daha kolay, ancak yine de terimlerin iç içe geçtiği yazılar bulmak mümkün. SwaggerIO, Swagger'ı bir araç seti olarak ve OpenAPI'yi bir özellik olarak tanıtıyor . Swagger'ın OpenAPI spesifikasyonu oluşturmak için kullanıldığını söyleyebiliriz . Esasen bu ifade yanlış değildir, ancak gerçeğin tamamı da değildir.

terimlerin kullanımı

Geliştiriciler genellikle Swagger terimini en az iki bağlamda kullanır:

• spesifikasyonu uygulamak için bir takım araçları tanımlamak. Bazı araçlar Swagger Editor, Swagger UI, Swagger Codegen vs.'dir. Bu bir ekosistemdir.
• sürüm 2'nin teknik özelliklerini açıklamak için.*.*

Geliştiriciler, OpenAPI Spesifikasyonu 3 terimini çoğunlukla tek bir bağlamda kullanır:

• 3.*.* sürümünün özelliklerini açıklamak için. Topluluk, OAS, OAS3, OpenAPI Spec, OpenAPI 3 Spesifikasyonu vb. olarak anılır. Swagger Spesifikasyonu 2'nin halefi olarak OpenAPI 3'ü benimsediler .

Swagger ve OpenAPI'nin yakın arkadaşlar olmasının bir nedeni var. Tarih burada anahtar bileşendir.

SmartBear şirketi Swagger'ı koruyor. Kasım 2015'te The Linux Foundation, SmartBear, Google, Microsoft, Paypal ve diğer birkaç şirketle birlikte yeni bir organizasyon olan OpenAPI Initiative'i oluşturduklarını duyurdu. Girişimin birincil görevi, Swagger spesifikasyonunu genişletmekti.

Birkaç ay sonra girişim, Swagger'ı OpenAPI spesifikasyonu olarak yeniden adlandırdı. Girişim, kodu yeni depoya klonladı. Bu noktadan itibaren, bireyler her iki terimi de çeşitli bağlamlarda kullanmışlardır.

Son söz

Swagger eskiden hepsi bir arada, özellik ve araç setiydi. Bugün, Swagger bir araç setidir. OpenAPI bir belirtimdir. Bu kadar.

Farkı bilmek güzel. Yine de hangi terimi kullanırsanız kullanın, karşı taraf sizi anlayacaktır - sonuçta önemli olan tek şey budur.