Spring Boot Ve Swagger Ile REST API Dokümantasyonu – 1

0 321

Swagger yazdığımız servislerin dökümantasyonunu yapan bir kütüphane. Dökümantasyonun önemini ve swagger’ı açıklayan hali hazırda bir yazımız mevcut. Orada problem güzel açıklandığı için öncelikle onu okumanızı tavsiye ederim. Biz Spring Boot tarafında nasıl implemente edeceğimize odaklanacağız.

Prrojemiz maven ve spring boot olacak. Pom.xml dosyamıza aşağıdaki dependencies ekliyoruz.

HTTP metodlarını örneklemek için birden fazla metod yazacağım fakat odak noktamız servis ve repository katmanları olmadığı için ayrıca yazmayacağım. Controller’ımız ise aşağıdaki gibi olacak.

Servis metodlarımızdan sonra ise swagger konfigürasyonunu yapıyoruz.

Uygulamamızı çalıştırıp http://localhost:8080/swagger-ui.html adresine giderseniz aşağıdaki gibi bir sayfa göreceksiniz.

Eğer GET metodunun detayına gidip Try It Out diyip execute derseniz. Servisi sorgulayacaktır ve sonuçları getirecektir.

Sorgulama yapmadan da eğer uygulama 200, 401, 403 ve 404 alırsa ne döneceğini görebilirsiniz. Biz bu durumlar için geliştirme yapmadığımız için bir durum ifade etmiyor.

 

Not: Eğer siz de benim gibi Spring Security kullanıyorsunuz yukarıda söylediğim linke direkt olarak ulaşamazsınız. Şöyle bir konfigürasyon gereklidir.

Yazının fazla uzamaması için ikiye böldüm. İkinci bölümde görüşmek üzere.

Faydalı olması dileğiyle.

Yorum yaz

Email adresiniz yayınlanmayacaktır.