Skip to content

Commit

Permalink
[refactor] swagger description 수정 (순서에 맞게)
Browse files Browse the repository at this point in the history
  • Loading branch information
hyeesw committed Aug 23, 2024
1 parent e91148b commit 3ee0312
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
Expand All @@ -29,7 +28,7 @@
@RequestMapping("/api/auth")
@RequiredArgsConstructor
@Slf4j
@Tag(name = "유저 관리", description = "회원가입 / 로그인 / 로그아웃 / 회원 탈퇴 / 카카오 로그인 / 애플 로그인")
@Tag(name="유저 관리", description = "탈퇴 / 회원가입 / 로그인 / 카카오 로그인 / 애플 로그인")
public class AuthController {

private final AuthService authService;
Expand Down Expand Up @@ -67,6 +66,8 @@ public ResponseEntity<?> login(@Valid @RequestBody LoginDto loginDto) {
// return ResponseEntity.ok("success");
// }

@Operation(summary = "탈퇴",
responses = {@ApiResponse(responseCode = "204", description = "회원 탈퇴가 완료되었습니다.")})
@DeleteMapping("/delete")
public ResponseEntity<?> deleteAccount() {
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
@RequestMapping("/api/book")
@RequiredArgsConstructor
@Slf4j
@Tag(name="메인", description = "책 추천, 대출 급상승, 지난달 키워드, 조건형 인기 대출 도서")
@Tag(name="메인", description = "책 추천 / 지난달 키워드 / 대출 급상승 / 조건형 인기 대출 도서")
public class BookController {
private final BookService bookService;
private final ResponseTemplate responseTemplate;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
@RequestMapping("/api/genre")
@RequiredArgsConstructor
@Slf4j
@Tag(name="장르", description = "일주일 인기순 / 한 달 인기순 / 이번 주 인기 도서 / 무작위순 / 신작 인기순")
@Tag(name="장르", description = "이번 주 인기 도서 / 무작위순 / 신작 인기순 / 일주일 인기순 / 한 달 인기순")
public class GenreController {
private final GenreService genreService;
private final RequestValidate requestValidate;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
@RestController
@RequiredArgsConstructor
@Slf4j
@Tag(name="채팅", description = "메세지 저장 / 메세지 불러오기")
@Tag(name="채팅", description = "메세지 불러오기 / 메세지 저장")
public class MessageController {
private final MessageService messageService;
private final ResponseTemplate responseTemplate;
Expand All @@ -50,7 +50,7 @@ public void chat(MessageRequestDto messageRequestDto) {


// 채팅 불러오기
@Operation(summary="채팅 불러오기 (특정 오픈톡)", description="오픈톡 ID 를 입력으로 받아 pageSize개 데이터를 반환합니다. (pageNo로 페이지네이션)",
@Operation(summary="메세지 불러오기 (특정 오픈톡)", description="오픈톡 ID 를 입력으로 받아 pageSize개 데이터를 반환합니다. (pageNo로 페이지네이션)",
parameters = {@Parameter(name = "opentalkId", description = "오픈톡 DB ID"), @Parameter(name = "pageNo", description = "페이지 번호(0부터)"), @Parameter(name = "pageSize", description = "페이지 당 개수")},
responses = {@ApiResponse(responseCode = "200", content = @Content(schema = @Schema(implementation = MessageResponseDto.class)),
description = MessageResponseDto.description)})
Expand All @@ -66,7 +66,7 @@ public ResponseEntity<?> getChat(@RequestParam String opentalkId, int pageNo, in
}

// swagger docs 에 남기기 위한 용도
@Operation(summary="채팅 stomp 통신", description="APIC 테스터기를 이용해서 stomp 통신을 합니다. \n" +
@Operation(summary="메세지 저장 (채팅 stomp 통신)", description="APIC 테스터기를 이용해서 stomp 통신을 합니다. \n" +
"- Request URL: ws://52.79.187.133:8080/ws-stomp \n"+
"- Destination Queue: /pub/message \n"+
"- Subscription URL: /sub/message/{opentalkId}",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
@RequestMapping("/api/opentalk")
@RequiredArgsConstructor
@Slf4j
@Tag(name="오픈톡", description = "메인 / 채팅 불러오기 / 오픈톡 참여하기")
@Tag(name="오픈톡", description = "메인 / 오픈톡 참여하기")
public class OpentalkController {
private final OpentalkService opentalkService;
private final ResponseTemplate responseTemplate;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
@RequestMapping("/api/user")
@RequiredArgsConstructor
@Slf4j
@Tag(name="마이페이지", description = "유저 정보 조회 / 유저 정보 수정 / 내 도서관 조회 / 내 도서관 수정")
@Tag(name="마이페이지", description = "내 도서관 조회 / 유저 정보 조회 / 내 도서관 수정 / 유저 정보 수정")
public class UserController {
private final UserService userService;
private final ResponseTemplate responseTemplate;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
@RequestMapping("/api/book/dibs")
@RequiredArgsConstructor
@Slf4j
@Tag(name="책 찜", description = "찜 추가 / 찜 해제")
@Tag(name="책 찜", description = "찜 해제 / 찜 추가")
public class UserBookController {
private final RequestValidate requestValidate;
private final UserBookService userBookService;
Expand Down

0 comments on commit 3ee0312

Please sign in to comment.