refactor : swagger summary 명시

.github/workflows/gradle.yml

@@ -8,13 +8,9 @@
 name: Java CI with Gradle
 
 on:
-  push:
-    branches:
-      - ci-cd
-      - main
   pull_request:
+    types: [closed]
     branches:
-      - ci-cd
       - main
 
 permissions:

src/main/java/com/example/bigbrotherbe/domain/member/controller/MemberController.java

@@ -1,17 +1,28 @@
 package com.example.bigbrotherbe.domain.member.controller;
 
+import com.example.bigbrotherbe.domain.member.entity.dto.request.ChangePasswordRequest;
+import com.example.bigbrotherbe.domain.member.entity.dto.request.MemberRequest;
 import com.example.bigbrotherbe.domain.member.entity.dto.request.SignUpDto;
+import com.example.bigbrotherbe.domain.member.entity.dto.response.MemberInfoResponse;
 import com.example.bigbrotherbe.domain.member.entity.dto.response.MemberResponse;
+import com.example.bigbrotherbe.domain.member.entity.role.AffiliationMap;
+import com.example.bigbrotherbe.global.email.EmailRequest;
+import com.example.bigbrotherbe.global.email.EmailVerificationResult;
+import com.example.bigbrotherbe.global.jwt.JwtToken;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import io.swagger.v3.oas.annotations.tags.Tag;
+import java.util.Map;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
 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.RequestParam;
 
 
 @RequestMapping("/api/big-brother/members")
@@ -26,4 +37,32 @@ public interface MemberController {
             @ApiResponse(responseCode = "404", description = "?")
     })
     ResponseEntity<com.example.bigbrotherbe.global.exception.response.ApiResponse<MemberResponse>> signUp(@RequestBody SignUpDto signUpDto);
+
+    @Operation(summary = "로그인")
+    @PostMapping("/sign-in")
+    JwtToken signIn(@RequestBody MemberRequest memberRequest);
+
+    @PostMapping("/test")
+    @Operation(summary = "test용", description = "현재는 로그인 멤버의 AffiliationRoleLost를 가져오는 값")
+    ResponseEntity<com.example.bigbrotherbe.global.exception.response.ApiResponse<AffiliationMap>> test();
+
+    @GetMapping
+    @Operation(summary = "유저 상세 정보 조회")
+    ResponseEntity<com.example.bigbrotherbe.global.exception.response.ApiResponse<MemberInfoResponse>> inquireMemberInfo();
+
+    @GetMapping("/sign-up/emails/verification")
+    @Operation(summary = "이메일 중복확인")
+    ResponseEntity<EmailVerificationResult> verificateEmail(@RequestParam(name = "member-email") String email);
+
+    @PostMapping("/sign-up/emails/request-code")
+    @Operation(summary = "이메일 인증 코드 요청")
+    ResponseEntity<EmailVerificationResult> sendMessage(@RequestBody EmailRequest emailRequest);
+
+    @GetMapping("/sign-up/emails/verifications")
+    @Operation(summary = "이메일 인증 코드 검증")
+    ResponseEntity<EmailVerificationResult> verificationEmail(@RequestParam(name = "email") String email, @RequestParam(name = "code") String code);
+
+    @PatchMapping()
+    @Operation(summary = "비밀번호 변경")
+    ResponseEntity<com.example.bigbrotherbe.global.exception.response.ApiResponse<Void>> changePassword(@RequestBody ChangePasswordRequest changePasswordRequest);
 }

src/main/java/com/example/bigbrotherbe/domain/member/controller/MemberControllerImpl.java

@@ -6,6 +6,7 @@
 import com.example.bigbrotherbe.domain.member.entity.dto.response.MemberInfoResponse;
 import com.example.bigbrotherbe.domain.member.entity.dto.response.MemberResponse;
 import com.example.bigbrotherbe.domain.member.entity.role.AffiliationMap;
+import com.example.bigbrotherbe.global.email.EmailRequest;
 import com.example.bigbrotherbe.global.email.EmailVerificationResult;
 import com.example.bigbrotherbe.global.exception.response.ApiResponse;
 import com.example.bigbrotherbe.global.jwt.AuthUtil;
@@ -45,9 +46,7 @@ public ResponseEntity<ApiResponse<MemberResponse>> signUp( SignUpDto signUpDto)
         return ResponseEntity.ok(ApiResponse.success(SUCCESS, memberResponse));
     }
 
-
-    @PostMapping("/sign-in")
-    public JwtToken signIn(@RequestBody MemberRequest memberRequest) {
+    public JwtToken signIn(MemberRequest memberRequest) {
         String memberEmail = memberRequest.getMemberEmail();
         String password = memberRequest.getMemberPass();
         // 컨트롤러가 없어도 굴러가게 만들어야 하는 데 그러면 Request 객체를 그대로 넘겨주나?
@@ -58,57 +57,32 @@ public JwtToken signIn(@RequestBody MemberRequest memberRequest) {
         return jwtToken;
     }
 
-    @PostMapping("/test")
-    public ResponseEntity<ApiResponse<AffiliationMap>> test() {
-//        memberService.makeAffiliation();
 
+    public ResponseEntity<ApiResponse<AffiliationMap>> test() {
         return ResponseEntity.ok(ApiResponse.success(SUCCESS,memberService.getMemberAffiliationRoleList()));
 
     }
 
-    // member 상세 조회
-    @GetMapping
     public ResponseEntity<ApiResponse<MemberInfoResponse>> inquireMemberInfo() {
         return ResponseEntity.ok(ApiResponse.success(SUCCESS,memberService.inquireMemberInfo()));
     }
 
-    @PostMapping("/admins")
-    public JwtToken adminLogin(@RequestBody MemberRequest memberRequest) {
-        String memberEmail = memberRequest.getMemberEmail();
-        String password = memberRequest.getMemberPass();
-        JwtToken jwtToken = memberService.userSignIN(memberEmail, password);
-        log.info("request memberName = {}, password = {}", memberEmail, password);
-        log.info("jwtToken accessToken = {}, refreshToken = {}", jwtToken.getAccessToken(),
-                jwtToken.getRefreshToken());
-        return jwtToken;
-    }
-
-    @PostMapping("/manager")
-    public String adminTest() {
-        return SecurityConfig.getCurrentUserName();
-    }
-
-    // 이메일 중복 확인
-    @GetMapping("/sign-up/emails/verification")
-    public ResponseEntity<EmailVerificationResult> verificateEmail(@RequestParam(name = "member-email") String email) {
+    public ResponseEntity<EmailVerificationResult> verificateEmail(String email) {
         return ResponseEntity.ok(memberService.verificateEmail(email));
     }
 
-    // 이메일 인증 코드 요구
-    @PostMapping("/sign-up/emails/request-code")
-    public ResponseEntity<EmailVerificationResult> sendMessage(@RequestBody Map<String, String> email) {
-        memberService.sendCodeToEmail(email.get("email"));
-
+    public ResponseEntity<EmailVerificationResult> sendMessage(EmailRequest emailRequest) {
+        memberService.sendCodeToEmail(emailRequest.getEmail());
         return ResponseEntity.ok(EmailVerificationResult.builder().authResult(true).build());
     }
 
-    @GetMapping("/sign-up/emails/verifications")
-    public ResponseEntity<EmailVerificationResult> verificationEmail(@RequestParam(name = "email") String email, @RequestParam(name = "code") String code) {
+
+    public ResponseEntity<EmailVerificationResult> verificationEmail(String email, String code) {
         return ResponseEntity.ok(memberService.verifiedCode(email, code));
     }
 
-    @PatchMapping()
-    public ResponseEntity<ApiResponse<Void>> changePassword(@RequestBody ChangePasswordRequest changePasswordRequest) {
+
+    public ResponseEntity<ApiResponse<Void>> changePassword( ChangePasswordRequest changePasswordRequest) {
         memberService.changePasswrd(changePasswordRequest.password());
         return ResponseEntity.ok(ApiResponse.success(SUCCESS));
     }