Merge pull request #24 from FortuneMon/chore/#23-swagger-write

chore: #23 swagger 설명 작성

Author: Seung-Un

src/main/java/FortuneMonBackEnd/fortuneMon/controller/FortuneController.java

@@ -3,6 +3,7 @@
 import FortuneMonBackEnd.fortuneMon.DTO.FortuneResponse;
 import FortuneMonBackEnd.fortuneMon.apiPayload.ApiResponse;
 import FortuneMonBackEnd.fortuneMon.service.FortuneService;
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
@@ -14,6 +15,8 @@
 public class FortuneController {
     private final FortuneService fortuneService;
 
+    @Operation(summary = "오늘의 운세 조회", description =
+            "# 오늘의 운세 조회 API입니다. 로그인 후 진행하세요.")
     @GetMapping("/users/fortune")
     public ApiResponse<?> getTodayFortune(){
         LocalDate today = LocalDate.now();

src/main/java/FortuneMonBackEnd/fortuneMon/controller/UserMonsterBallController.java

@@ -4,6 +4,7 @@
 import FortuneMonBackEnd.fortuneMon.DTO.UserPokemonDTO;
 import FortuneMonBackEnd.fortuneMon.config.security.SecurityUtil;
 import FortuneMonBackEnd.fortuneMon.service.UserMonsterBallService;
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.data.repository.query.Param;
 import org.springframework.web.bind.annotation.*;
@@ -16,13 +17,17 @@
 public class UserMonsterBallController {
     private final UserMonsterBallService userMonsterBallService;
 
+    @Operation(summary = "유저가 가진 몬스터볼 개수 조회", description =
+            "# 유저 몬스터볼 조회 API입니다. 로그인 후 진행하세요.")
     @GetMapping("")
     public List<UserMonsterBallResponseDTO> getUserMonsterBall(){
         Long userId = SecurityUtil.getCurrentUserId();
 
         return userMonsterBallService.getUserMonsterBall(userId);
     }
 
+    @Operation(summary = "몬스터볼 오픈", description =
+            "# 몬스터볼을 오픈하는 API입니다. 로그인 후 진행하세요.")
     @PostMapping("/{id}/open")
     public UserPokemonDTO openMonsterBall(@PathVariable("id") Long ballId){
         return userMonsterBallService.openMonsterBall(ballId);

src/main/java/FortuneMonBackEnd/fortuneMon/controller/UserPokemonController.java

@@ -3,6 +3,7 @@
 import FortuneMonBackEnd.fortuneMon.DTO.UserPokemonDTO;
 import FortuneMonBackEnd.fortuneMon.config.security.SecurityUtil;
 import FortuneMonBackEnd.fortuneMon.service.UserPokemonServiceImpl;
+import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
 
@@ -16,12 +17,16 @@ public class UserPokemonController {
 
     // 요청 받으면 Service 호출해서 유저가 보유한 포켓몬을 표시하여 반환함
     // 유저의 id를 받아서 id를 기준으로 유저의 포켓몬 정보를 가져온다
+    @Operation(summary = "유저 포켓몬 조회", description =
+            "# 유저 포켓몬 조회 API입니다. 로그인 후 진행하세요.")
     @GetMapping("/pokemons")
     public List<UserPokemonDTO> getPokemonsWithOwnership(){
         Long userId = SecurityUtil.getCurrentUserId();
         return userPokemonService.getUserPokemonsWithOwnership(userId);
     }
 
+    @Operation(summary = "파트너 포켓몬 설정", description =
+            "# 파트너 포켓몬 설정 API입니다. 로그인 후 진행하세요.")
     @PatchMapping("/partners/{id}")
     public UserPokemonDTO setPartnerPokemon(@PathVariable("id") Long pokemonId){
         return userPokemonService.setPartnerPokemon(pokemonId);