Merge pull request #23 from wafflestudio/feat/swagger-init

Swagger init settings

.gitignore

@@ -2,6 +2,7 @@
 /shelf/
 /.idea/workspace.xml
 /.idea/modules.xml
+/.idea/httpRequests/*
 # Editor-based HTTP Client requests
 /httpRequests/
 # Datasource local storage ignored files

build.gradle.kts

@@ -28,6 +28,7 @@ dependencies {
     implementation("org.springframework.boot:spring-boot-starter-web")
     implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
     implementation("org.jetbrains.kotlin:kotlin-reflect")
+    implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0")
     runtimeOnly("com.mysql:mysql-connector-j")
     testImplementation("org.springframework.boot:spring-boot-starter-test")
     testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")

src/main/kotlin/com/example/toyTeam6Airbnb/SwaggerConfig.kt

@@ -0,0 +1,47 @@
+package com.example.toyTeam6Airbnb
+
+import io.swagger.v3.oas.annotations.OpenAPIDefinition
+import io.swagger.v3.oas.models.Components
+import io.swagger.v3.oas.models.OpenAPI
+import io.swagger.v3.oas.models.info.Info
+import io.swagger.v3.oas.models.security.SecurityRequirement
+import io.swagger.v3.oas.models.security.SecurityScheme
+import io.swagger.v3.oas.models.security.SecurityScheme.Type
+import io.swagger.v3.oas.models.servers.Server
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer
+
+@Configuration
+@OpenAPIDefinition(
+    info = io.swagger.v3.oas.annotations.info.Info(
+        title = "Airbnb API",
+        version = "1.0"
+    )
+)
+class SwaggerConfig : WebMvcConfigurer {
+
+    @Bean
+    fun openAPI(): OpenAPI {
+        return OpenAPI()
+            .addSecurityItem(
+                SecurityRequirement().addList("Bearer Authentication")
+            )
+            .components(
+                Components().addSecuritySchemes
+                ("Bearer Authentication", createAPIKeyScheme())
+            )
+            .addServersItem(Server().url("/"))
+            .info(
+                Info().title("WEBTOON API")
+                    .description("Webtoon API Spec")
+                    .version("v1.0.0")
+            )
+    }
+
+    fun createAPIKeyScheme(): SecurityScheme? {
+        return SecurityScheme().type(Type.HTTP)
+            .bearerFormat("JWT")
+            .scheme("bearer")
+    }
+}

src/main/kotlin/com/example/toyTeam6Airbnb/profile/controller/ProfileController.kt

@@ -1,3 +1,8 @@
 package com.example.toyTeam6Airbnb.profile.controller
 
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+@RequestMapping("/api/v1")
 class ProfileController

src/main/kotlin/com/example/toyTeam6Airbnb/profile/service/ProfileServiceImpl.kt

@@ -1,3 +1,6 @@
 package com.example.toyTeam6Airbnb.profile.service
 
-class ProfileServiceImpl
+import org.springframework.stereotype.Service
+
+@Service
+class ProfileServiceImpl : ProfileService

src/main/kotlin/com/example/toyTeam6Airbnb/reservation/controller/ReservationController.kt

@@ -1,3 +1,8 @@
 package com.example.toyTeam6Airbnb.reservation.controller
 
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+@RequestMapping("/api/v1")
 class ReservationController

src/main/kotlin/com/example/toyTeam6Airbnb/reservation/service/ReservationServiceImpl.kt

@@ -1,3 +1,6 @@
 package com.example.toyTeam6Airbnb.reservation.service
 
-class ReservationServiceImpl
+import org.springframework.stereotype.Service
+
+@Service
+class ReservationServiceImpl : ReservationService

src/main/kotlin/com/example/toyTeam6Airbnb/review/controller/ReviewController.kt

@@ -1,3 +1,8 @@
 package com.example.toyTeam6Airbnb.review.controller
 
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+@RequestMapping("/api/v1")
 class ReviewController

src/main/kotlin/com/example/toyTeam6Airbnb/review/service/ReviewServiceImpl.kt

@@ -1,3 +1,6 @@
 package com.example.toyTeam6Airbnb.review.service
 
-class ReviewServiceImpl
+import org.springframework.stereotype.Service
+
+@Service
+class ReviewServiceImpl : ReviewService

src/main/kotlin/com/example/toyTeam6Airbnb/room/controller/RoomController.kt

@@ -1,3 +1,8 @@
 package com.example.toyTeam6Airbnb.room.controller
 
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+@RequestMapping("/api/v1")
 class RoomController

src/main/kotlin/com/example/toyTeam6Airbnb/room/service/RoomServiceImpl.kt

@@ -1,3 +1,6 @@
 package com.example.toyTeam6Airbnb.room.service
 
-class RoomServiceImpl
+import org.springframework.stereotype.Service
+
+@Service
+class RoomServiceImpl : RoomService

src/main/kotlin/com/example/toyTeam6Airbnb/user/controller/UserController.kt

@@ -1,3 +1,22 @@
 package com.example.toyTeam6Airbnb.user.controller
 
-class UserController
+import com.example.toyTeam6Airbnb.user.service.UserService
+import io.swagger.v3.oas.annotations.Operation
+import io.swagger.v3.oas.annotations.tags.Tag
+import org.springframework.http.ResponseEntity
+import org.springframework.web.bind.annotation.PostMapping
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+@RequestMapping("/api/v1")
+@Tag(name = "User Controller", description = "User Controller API")
+class UserController(
+    private val userService: UserService
+) {
+    @PostMapping("/ping")
+    @Operation(summary = "Ping pong", description = "Sample ping pong api for testing")
+    fun ping(): ResponseEntity<String> {
+        return ResponseEntity.ok("pong")
+    }
+}

src/main/kotlin/com/example/toyTeam6Airbnb/user/service/UserServiceImpl.kt

@@ -1,3 +1,6 @@
 package com.example.toyTeam6Airbnb.user.service
 
-class UserServiceImpl
+import org.springframework.stereotype.Service
+
+@Service
+class UserServiceImpl : UserService

src/main/resources/UserApi.http

@@ -0,0 +1,6 @@
+### Pingpong
+POST http://localhost:8080/api/v1/ping
+Content-Type: application/json
+
+{
+}

src/main/resources/application.yaml

@@ -14,6 +14,12 @@ spring:
   profiles:
     active: dev
 
+springdoc:
+  api-docs:
+    path: /api-docs
+  swagger-ui:
+    path: /swagger-ui
+
 cache:
   expire-after-write: 1m
   maximum-size: 100