Merge pull request #6 from Team-UMC/feature/#5/swagger

[FEAT] Swagger setting

.github/workflows/umc-service-dev.yml

@@ -62,6 +62,6 @@ jobs:
           script: |
             cd /
             sudo docker-compose -f docker-compose.dev.yml down
-            sudo docker pull   ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_REPO }}-dev
+            sudo docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_REPO }}-dev
             sudo docker-compose -f docker-compose.dev.yml up -d
             sudo docker image prune -f

.github/workflows/umc-service-prod.yml

@@ -63,6 +63,6 @@ jobs:
           port: 22
           script: |
             sudo docker-compose -f docker-compose.prod.yml down
-            sudo docker pull ${{ secrets.DOCKER_REPO }}
+            sudo docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_REPO }}
             sudo docker-compose -f docker-compose.prod.yml up -d
             sudo docker image prune -f

.gitignore

@@ -36,5 +36,4 @@ out/
 ### VS Code ###
 .vscode/
 
-.env
 application.yml

Dockerfile

@@ -1,4 +1,4 @@
 FROM openjdk:17
 ARG JAR_FILE=build/libs/*.jar
-COPY ${JAR_FILE} flory.jar
-ENTRYPOINT ["java","-jar","/flory.jar"]
+COPY ${JAR_FILE} umcservice.jar
+ENTRYPOINT ["java","-jar","/umcservice.jar"]

build.gradle

@@ -28,6 +28,9 @@ dependencies {
 	runtimeOnly 'com.mysql:mysql-connector-j'
 	annotationProcessor 'org.projectlombok:lombok'
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
+
+	// swagger setting
+	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
 }
 
 tasks.named('test') {

src/main/java/com/umc/networkingService/config/SwaggerConfig.java

@@ -0,0 +1,24 @@
+package com.umc.networkingService.config;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class SwaggerConfig {
+    @Bean
+    public OpenAPI openAPI() {
+        return new OpenAPI()
+                .components(new Components())
+                .info(apiInfo());
+    }
+
+    private Info apiInfo() {
+        return new Info()
+                .title("UMC 네트워킹 서비스 API 명세서")
+                .description("Swagger UI for UMC 네트워킹 서비스")
+                .version("1.0.0");
+    }
+}

src/main/java/com/umc/networkingService/domain/test/controller/TestController.java

@@ -1,17 +1,35 @@
 package com.umc.networkingService.domain.test.controller;
 
+import io.swagger.v3.oas.annotations.Hidden;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
+@Tag(name = "예제 API", description = "Swagger 테스트용 API")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/test")
 public class TestController {
+    @Operation(summary = "문자열 반복", description = "파라미터로 받은 문자열을 2번 반복합니다.")
+    @Parameter(name = "str", description = "2번 반복할 문자열")
+    @GetMapping("/returnStr")
+    public String returnStr(@RequestParam String str) {
+        return str + "\n" + str;
+    }
+
+    @GetMapping("/example")
+    public String example() {
+        return "예시 API";
+    }
 
-    @GetMapping
-    public String getTest() {
-        return "kimjunseok";
+    @Hidden
+    @GetMapping("/ignore")
+    public String ignore() {
+        return "무시되는 API";
     }
-}
+}