Merge pull request #6 from depromeet/feature/swagger

docs #5 - Add swagger

pom.xml

@@ -16,6 +16,7 @@
 
 	<properties>
 		<java.version>1.8</java.version>
+		<swagger.version>2.9.2</swagger.version>
 	</properties>
 
 	<dependencies>
@@ -49,6 +50,16 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger2</artifactId>
+			<version>${swagger.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-swagger-ui</artifactId>
+			<version>${swagger.version}</version>
+		</dependency>
 	</dependencies>
 
 	<build>

src/main/java/com/depromeet/warmingupteam0backend/config/SwaggerConfig.java

@@ -0,0 +1,23 @@
+package com.depromeet.warmingupteam0backend.config;
+
+import com.google.common.base.Predicates;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+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;
+
+@EnableSwagger2
+@Configuration
+public class SwaggerConfig {
+    @Bean
+    public Docket docket() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .select()
+                .apis(RequestHandlerSelectors.any())
+                .paths(Predicates.not(PathSelectors.regex("/error.*")))     // basic error controller
+                .build();
+    }
+}

src/main/java/com/depromeet/warmingupteam0backend/controller/HelloController.java

@@ -0,0 +1,21 @@
+package com.depromeet.warmingupteam0backend.controller;
+
+import com.depromeet.warmingupteam0backend.dto.HelloRequest;
+import com.depromeet.warmingupteam0backend.dto.HelloResponse;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api")
+public class HelloController {
+    @PostMapping("/hello")
+    public HelloResponse sayHello(@RequestBody HelloRequest helloRequest) {
+        String name = helloRequest.getName();
+
+        HelloResponse helloResponse = new HelloResponse();
+        helloResponse.setMessage("Hello, " + name + "!");
+        return helloResponse;
+    }
+}

src/main/java/com/depromeet/warmingupteam0backend/dto/HelloRequest.java

@@ -0,0 +1,8 @@
+package com.depromeet.warmingupteam0backend.dto;
+
+import lombok.Data;
+
+@Data
+public class HelloRequest {
+    private String name;
+}

src/main/java/com/depromeet/warmingupteam0backend/dto/HelloResponse.java

@@ -0,0 +1,8 @@
+package com.depromeet.warmingupteam0backend.dto;
+
+import lombok.Data;
+
+@Data
+public class HelloResponse {
+    private String message;
+}