Swagger Nedir ? Swagger Neden Kullanılır ? Ne İşe Yarar ?

Swagger nedir sorusunu cevaplamadan önce Web Api ve Web Servis Nedir ? soruslarını cevaplamış olduğum yazılara bir göz gezdirmenizi rica edeceğim. Çünkü Swagger doğrudan APIlar ile bağlantılı bir konudur.

Swagger Nedir ?

Bir uygulama geliştirdiğinizi düşünün. Bu uygulamanın diğer uygulamalar ile entegre bir şekilde çalışabilmesi için API oluşturduğunuzu düşünün. Sizin uygulamanız ile bu API’ı kullanarak iletişime geçecek kişiye: “Al kardeşim bu API kullan” demek yerine muhtemelen API ile birlikte bir de dokümantasyon vereceksinizdir.

Zaman içerisinde API’ınız kendisini geliştirecek ve değişecektir. Belki API içerisindeki bazı fonksiyonları sileceksiniz belki de yeni fonksiyonlar ekleyeceksiniz. API üzerinde yapmış olduğunuz her bir değişiklik sonrası gidip dökümanınızı da güncellemek zorunda kalacaksınız. Sizi bu uğraştan kurtarmak için Swagger imdadınıza yetişiyor.

RestApi web servisleri için Swagger bir arayüz oluşturmaktadır. Bu arayüz sayesinde bilgisayarlar ve insanlar kodlara erişmeden RestApilerin özelliklerini görme, inceleme ve anlayabilmektedir.

Webservisiadresi/swagger-ui.html şeklindeki adrese tarayıcı üzerinden erişerek Swagger tarafından oluşturulmuş olan dökümana erişebilirsiniz. Bu dökümanla birlikte requested / response modellerine ait örnekler görebilirsiniz.

Swagger aynı zamanda servisleri çok daha kolay bir şekilde test etmenize olanak tanır. POSTMAN gibi uygulamalara gerek duymadan Swagger’a sahip bir web servisine tarayıcı üzerinden direk GET ve POST gibi requested işlemlerini yapabilirsiniz.

Swagger sayesinde web servislerinin dökümante edilmesi hem kolaylaşmış oluyor hem de hepsi bir standart ile dökümante edilmiş oluyor. Bu bizim gibi yazılımcılar için çifte avantaj sayılır.

Bir cevap yazın

E-posta hesabınız yayımlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir