Rest Api'yi Swagger Uyumlu Hale Getirmek

Herkese merhaba, bu yazımda bir Rest Apinin Swagger uyumlu hale getirilmesindeki adımlardan bahsedeceğim. Neleri eklememiz gerektiğinden, hangi özellikler için hangi metodları kullandığımızdan bahsedeceğim.

*Swagger-UI: 
Bir bağımlılığa sahip değildir, kendi yerel makinemizde çalıştırabiliriz. Apinin swagger uyumlu hale geldikten sonraki görüntüsüne örnek olarak petstore uygulaması verilebilir.

Şimdi apiyi swagger uyumlu hale getirmek için izlenecek adımları sırayla uygulamaya başlayalım.

1-)Öncelikle apimizde bulunan pom.xml dosyasının içine gereken bağımlılıkları ekliyoruz.

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-jaxrs</artifactId>
    <version>${swagger-version}</version>
    <scope>compile</scope>
</dependency>

2-) Daha sonra buradan Swagger-ui paketini indiriyoruz.

-> Bu indirdiğimiz paketin içindeki dist klasörünün içindeki bütün dosyaları kopyalıyoruz.
-> Projemizin içinde src/main/webapp içine bir swagger klasörü oluşturalım. Kopyaladığımız bütün dosyaları bu klasörün içine yapıştıralım.

3-) Şimdi de webconfig.java dosyamızın içine port bilgisi, url bilgisi, uygulama adı gibi swaggerı servera tanımlayacak bilgileri giriyoruz.

4-) Şimdi ise apimizi swagger uyumlu hale getirebilmek için kod içeriklerinde değişiklikler yapıyoruz.

Bu kısımda birçok ek açıklamalar kullanıyoruz.

@Api: Başına getirilen sınıfı bir swagger kaynağı olarak işaretler.

@ApiModel: Swagger modelleri hakkında bilgiler eklememizi sağlar.

@ApiOperation: Özel olarak belirlediğimiz bir yola karşılık gelen bir tanımlama yapar.

@ApiParam: İşlemdeki parametreleri tanımlarız.

@ApiResponse: İşlem sırasında oluşabilecek hataları tanımlarız.

Tüm bunları gerçekleştirdikten sonra şekildeki gibi bir görüntü çıkar.

Burada petstore uygulamasının Pet, Store ve User modellerinden User'ın içindeki işlemler yer almaktadır.

Bu uygulamanın kaynak kodu şu adreste bulunmaktadır.
 İyi çalışmalar dilerim.