Skip to content

Commit ce6035b

Browse files
committed
feat: add SwaggerConfig
1 parent efa9a84 commit ce6035b

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
package com.cloudcomputing.ohhanahana.config;
2+
3+
import io.swagger.v3.oas.models.OpenAPI;
4+
import io.swagger.v3.oas.models.info.Info;
5+
import org.springframework.context.annotation.Bean;
6+
import org.springframework.context.annotation.Configuration;
7+
8+
@Configuration
9+
public class SwaggerConfig {
10+
11+
@Bean
12+
public OpenAPI customOpenAPI() {
13+
return new OpenAPI()
14+
.info(new Info().title("오하나하나 API")
15+
.version("1.0")
16+
.description("API documentation for 오하나하나 application"));
17+
}
18+
}

src/main/java/com/cloudcomputing/ohhanahana/controller/BusController.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,24 @@
44
import com.cloudcomputing.ohhanahana.dto.response.RecommendResponse;
55
import com.cloudcomputing.ohhanahana.dto.response.ShuttleResponse;
66
import com.cloudcomputing.ohhanahana.service.BusService;
7+
import io.swagger.v3.oas.annotations.Operation;
8+
import io.swagger.v3.oas.annotations.tags.Tag;
79
import jakarta.xml.bind.JAXBException;
810
import lombok.RequiredArgsConstructor;
911
import org.springframework.http.ResponseEntity;
1012
import org.springframework.web.bind.annotation.GetMapping;
1113
import org.springframework.web.bind.annotation.RequestMapping;
1214
import org.springframework.web.bind.annotation.RestController;
1315

16+
@Tag(name = "버스 API", description = "버스 관련 API")
1417
@RestController
1518
@RequiredArgsConstructor
1619
@RequestMapping("/bus")
1720
public class BusController {
1821

1922
private final BusService busService;
2023

24+
@Operation(summary = "주변 정류장 버스 도착 정보 조회 API", description = "주변 정류장 버스 도착 정보를 조회하는 API입니다.")
2125
@GetMapping("/recommend")
2226
public ResponseEntity<RecommendResponse> recommendBus() {
2327
try {
@@ -28,13 +32,15 @@ public ResponseEntity<RecommendResponse> recommendBus() {
2832
}
2933
}
3034

35+
@Operation(summary = "셔틀버스 도착 정보 조회 API", description = "셔틀버스 도착 정보를 조회하는 API입니다.")
3136
@GetMapping("/shuttle")
3237
public ResponseEntity<ShuttleResponse> shuttleBus() {
3338
return busService.getShuttleBus()
3439
.map(ResponseEntity::ok)
3540
.orElseGet(() -> ResponseEntity.ok(null));
3641
}
3742

43+
@Operation(summary = "전체 버스 도착 정보 조회 API", description = "전체 버스 도착 정보를 조회하는 API입니다.")
3844
@GetMapping
3945
public ResponseEntity<BusResponse> findAllBus() {
4046
try {
@@ -45,6 +51,7 @@ public ResponseEntity<BusResponse> findAllBus() {
4551
}
4652
}
4753

54+
@Operation(summary = "511번 버스 도착 정보 조회 API", description = "511번 버스 도착 정보를 조회하는 API입니다.")
4855
@GetMapping("/511")
4956
public ResponseEntity<RecommendResponse.Bus> get511Bus() {
5057
try {

0 commit comments

Comments
 (0)