Added Swagger UI API integration

README.md

@@ -12,7 +12,12 @@
 - Spring Boot
 - NGINX
 - Maven
+- Swager API Spec's
 
 ## Run
 - Run command `docker-compose up`
 - Access to http://localhost/
+
+## Swagger2 UI
+- Access here http://localhost/swagger-ui.html
+

api.yaml

@@ -0,0 +1,10 @@
+swagger: "2.0"
+info:
+  title: Title
+  description: Title
+  version: 1.0.0
+host: localhost
+schemes:
+  - https
+paths: /
+

app/pom.xml

@@ -19,6 +19,21 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-freemarker</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>2.4.0</version>
+        </dependency>
+
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>2.4.0</version>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

app/src/main/java/com/hellokoding/springboot/Data.java

@@ -0,0 +1,23 @@
+package com.hellokoding.springboot;
+
+public class Data {
+
+    private int id;
+    private String text;
+
+    public int getId() {
+        return id;
+    }
+
+    public void setId(int id) {
+        this.id = id;
+    }
+
+    public String getText() {
+        return text;
+    }
+
+    public void setText(String text) {
+        this.text = text;
+    }
+}

app/src/main/java/com/hellokoding/springboot/DataController.java

@@ -0,0 +1,30 @@
+package com.hellokoding.springboot;
+
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RestController;
+
+
+@RestController
+public class DataController {
+
+    @RequestMapping(method = RequestMethod.GET, value = "/data/{id}")
+    public Data getData(@PathVariable Integer id) {
+        return new Data();
+    }
+
+    @RequestMapping(method = RequestMethod.POST, value = "/data")
+    public Data saveData(Data data) {
+        return data;
+    }
+
+    @RequestMapping(method = RequestMethod.PUT, value = "/data/{id}")
+    public Data updateData(@PathVariable Integer id, Data data) {
+        return data;
+    }
+
+    @RequestMapping(method = RequestMethod.DELETE, value = "/data/{id}")
+    public void deleteData(@PathVariable Integer id) {
+    }
+}

app/src/main/java/com/hellokoding/springboot/SwaggerConfig.java

@@ -0,0 +1,35 @@
+package com.hellokoding.springboot;
+
+import com.google.common.base.Predicates;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+@Configuration
+@EnableSwagger2
+public class SwaggerConfig {
+
+    @Bean
+    public Docket api() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .select()
+                .apis(RequestHandlerSelectors.basePackage("org.springframework.boot"))
+                .paths(PathSelectors.ant("/api/*"))
+                .build()
+                .apiInfo(apiInfo());
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfo(
+                "My REST API",
+                "Some custom description of API.",
+                "API TOS",
+                "Terms of service",
+                new Contact("Omer Younus", "www.example.com", "[email protected]"),
+                "License of API", "API license URL", Collections.emptyList());
+    }
+}