Swagger – Springfox MVC/RESTful Api Dökümantasyonu

Son dönemde RESTful servislerin popüler olması ile birlikte birçok yer projede bu servisleri görüyor. Hem geliştirirken hemde kullanırken farklı yöntemlerle işlerimizi yürütüyoruz.

RESTful servislerin doğası gereği bir tanım belgesi mevcut değil. Bu durum başlarda pek problem gibi görülmese de proje büyüdükçe ciddi bir problem haline dönüşüyor. Servisleri kullanmak için başka taraflara verdiğimizde bir dokümantasyona ihtiyaç olmakta. Hadi diyelim ki dokumanı hazırladık, geliştirme hengamesi içerisinde dokumanın güncelliğini sağlamakta ciddi bir problem haline geliyor.

Bu durumu çözümlemek için swagger grubu bir api dokümantasyon standardı belirlemiş ve bunu yayınlamış. Oldukça kullanışlı ve anlaşılır bir içerik sunuyor.

Sizde kendi apilerinizi dokümante etmek için bu standardı kullanabilirsiniz. Bu spesifikasyonu spring mvc/RESTful projeleri için uygulayan springfox projesini projenizee dahil edebilirsiniz.

Konuyla ilgili örnek uygulamaya aşağıdaki adresten erişebilirsiniz.

https://github.com/dilaverdemirel/springfox-swagger