Java Spring boot api ye swagger kurulumu

Swagger Nedir Ne İşe Yarar? 

Swager uygulama geliştiricilerin geliştirme esnasında oluşturdukları API yi postman gibi herhangi bir araç kullanmadan test etmeye yarar. Swager Java .NET vb dillerle yazılmış API lerle implemente edilerek Apilerin testlerinde kolaylık sağayan arayüzdür.

Kurulum aşamaları:

Güncel versiyonları takip edebilmek için aşağıdaki ingilizce kaynaktan da yararlanabilirsiniz.

https://www.baeldung.com/swagger-2-documentation-for-spring-rest-api

swagerin kurulumu düşünüldüğü kadar karışık değildir. Spring Boot Apisine İmplementasyonu 4 aşamadan oluşmaktadır. Bu aşamalar şu şekildedir.

1. projenizde bulunan pom.xml dökümanını açarak aşağıdaki satırları dependencies tagının içine yapıştırınız ve kaydediniz.

                    <dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>3.0.0</version>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-boot-starter</artifactId>

<version>3.0.0</version>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

<version>2.9.2</version>

</dependency>

2. pom.xml e eklenen dependency lerin projeye download edilmesi için projeyi kapatıp açmanızı öneririm. projeyi kapatıp açmak istemez iseniz de Maven menüsü altından önce clean sonra install yada package configrasyonlarına tıklayabilirsiniz.  

3. Bu işlem sonrası projenizin ana dizininde bulunan projeadiApplication.java dosysının içinde (src --> main --> java --> com --> projeadı ) aşağıdaki kodları yapıştırın.

public class projeadiApplication.java üstüne @EnableSwagger2 anatasyonu ekleyiniz ve kütüphanesini import ediniz.

public class projeadiApplication.java içinde bulunan main methodunun altına aşağdaki kodları yapıştırın ve ve kütüphanesini import ediniz.

            @Bean

            public Docket api() {

            return new Docket(DocumentationType.SWAGGER_2)

                .select()

                .apis(RequestHandlerSelectors.any())

                .paths(PathSelectors.any())

                .build();

            }

Eğer bir sebepten ötürü kütüphaneleri ideniz import etmiyorsa aşağıdaki satırları projenize ekleyebilirsiniz.

import org.springframework.context.annotation.Bean;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

4.Swagger kurulumu tamamlandı. kurulumu test etmek için projeyi çalıştıralım ve aşağıdaki adrese gidelim. Eğer port numarasında değişiklik yapmadı iseniz 8080 port numarası varsayılan olarak set edilecektir. Proje başlatıldığında hangi porttan çalıştığı görülmektedir. 

http://localhost:8080/swagger-ui.html bu adrese gidildiğinde başarı ile gerçekleşti ise sizi aşağıdaki ekran karşılamaktadır. 

Artık API nizde geliştirdiğiniz tüm methodları rahatlıkla tarayıcı üzerinden Swagger ile test edebilirsiniz. 

Kişisel Windosws bilgisayara Postgre SQL kurulumu

Postgre, Dünyanın En Gelişmiş Açık Kaynak İlişkisel Veritabanıdır. Tamamen ücretsizdir. Orta ölçekli bir web sitesinin tüm veritabanı ihtiyaçlarını fazlası ile karşılar. Profesyonel Projelerde PostgreSql MYSQL'e oranla performanstan cok stabiliteyi ön planda tutar. 

 Kısaca anlattığımıza göre hadi gelelim kurulum aşamalarına 

 1.https://www.enterprisedb.com/downloads/postgres-postgresql-downloads adresine gidilerek aşağıdaki görseldeki ekrandaki gibi son stabil versiyonu işletim sisteminize göre indirilebilir yada özellikle tercih ettiğiniz versiyonu varsa onu da indirebilirsiniz.

2.İndirilme sonrası indirilen exe dosyası çalıştırılır. Çalıştırılınca aşağıdaki uyarı çıkacaktı ve yes diyerek kuruluma devam edilir.

3. Açılan Pancerede birkere next diyerek Kurulum için istenilen bileşenlerin seçildiği yere gelinir. Biz tüm bileşenleri bilgisayarımıza kurmak istediğimizden tümünü işaretleyerek next butonuyla kurulumu devam ettiriyoruz.

4. Aşağıdaki görseldeki gibi kurulumun yapılacağı dizin ve veritabanıyla ilgili birkaç özet bilgilerin olduğu bir ekran gösterilir. isterseniz bu kısmı not alıp ileride ihtiyaç halinde kullanablirsiniz.

5.Birkaç kere next dedikten sonra aşağıdaki görseldeki gibi kurulum süreci başlamış olur.

6. İşlem tamamlandıktan sonra aşağıdaki gibi bir görsel gelecek ve ekrandaki tik işaretli yerin tik işaretini kaldırıp kurulumu tamamlayabilirsiniz.

7. Kurulum işlemi tamamlandı artık sırada veritabanı arayüzüne erişmekte. Bilgisayarın arama çubuğuna pgadmin yazarak postgresql in arayüzünü açabilirsiniz.

8.Arayüzü açtıktan sonra pgadmin in sol üst köşesindeki Database'e sağ tık Create --> Database tıklayarak yeni veritabanı oluşturabilirsiniz.

9. Açılan ekranda General Sekmesindeki Database yazan yere veritabanı ismi oluşturularak eğer isterseniz veritabanına bir sahip atamak için owner kısmını değiştirebilirsiniz.

10. Save yaptığımızda veritabanımız oluşmuş olur. oluşan veritabanına tablolar eklemek için varitabanı üstüne sağ tıklayarak create --> Table seçeneğini kullanabilirsiniz.

 

11. Eğer Tabloları oluştururken SQL kodları kullanmak isterseniz yukadırdaki görseldeki ekrandan Query Tool seçeneğini seçerek sql query editör ü açabilirsiniz. 

12. Halihazırda veritabanı tablolarını içeren SQL scriptleriniz var ise Query editörün üstündeki dosya işaredinden bilgisayarınızdaki SQL scriptinin açılmasını sağlayabilirsiniz. 

13. Yazdığınız yada import ettiğiniz sql scriptlerinizi çalıştırmak için aşağıdaki görselde yuvarlak içine alınan execute butonuna basarak çalıştırabilirsiniz.