Skip to content

refactor : 스웨거 필드 이름 추가 및 수정 #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LJW22222 merged 1 commit into from
Feb 24, 2025
Merged

refactor : 스웨거 필드 이름 추가 및 수정 #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/main/java/com/petmatz/api/chatting/ChatController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ public class ChatController {
private final SendChatMessage sendChatMessage;

@MessageMapping("/chat")
@Operation(summary = "메세지 전송", description = "양방향 통신 소켓 메세지 전송 API")
@Parameters({
@Parameter(name = "chatRoomId", description = "채팅방 번호", example = "1"),
@Parameter(name = "senderEmail ", description = "메세지 보내는 이의 Email", example = "test1@naver.com"),
@Parameter(name = "receiverEmail ", description = "메세지 받는 이의 Email", example = "test2@naver.com"),
@Parameter(name = "msg", description = "메세지 내용", example = "안녕하세요"),
@Parameter(name = "msg_type", description = "메세지 타입", example = "PLG [PLG, MSG, END]")
})
public void sendPrivateMessage(ChatMessageRequest chatMessageRequest) {
ChatMessageInfo chatMessageInfo = chatMessageRequest.of();
chatService.updateMessage(chatMessageInfo, chatMessageRequest.chatRoomId());
Expand All @@ -58,7 +66,7 @@ public void sendReadStatus(@Payload ChatReadStatusDirect chatReadStatusDirect,
@Parameter(name = "chatRoomId", description = "채팅방 번호", example = "1"),
@Parameter(name = "pageSize", description = "긁어올 페이지의 사이즈", example = "20 ( Default : 15 )"),
@Parameter(name = "startPage", description = "현재 페이지의 번호 ( 0은 안됨!! )", example = "3 ( Default 1 )"),
@Parameter(name = "lastReadTimestamp", description = "현재 페이지의 번호 ( 0은 안됨!! )", example = "3 ( Default 1 )")
@Parameter(name = "lastReadTimestamp", description = "마지막으로 잃은 메시지 타임", example = "2025-02-24T14:30:45.123456")
})
public Response<ChatMessageResponse> selectChatMessage(
@RequestParam String chatRoomId,
Expand Down
5 changes: 2 additions & 3 deletions src/main/java/com/petmatz/api/chatting/MatchingController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ public class MatchingController {
@PostMapping
@Operation(summary = "채팅방 생성", description = "채팅방을 생성하는 API API")
@Parameters({
@Parameter(name = "JWT [ caregiverInfo 추후 대체 ]", description = "토큰을 받아와 쓸 예정", example = "입력금지"),
@Parameter(name = "caregiverEmail", description = "반려인 닉네임", example = "반려인이름"),
@Parameter(name = "entrustedEmail", description = "돌봄이 닉네임", example = "돌봄이이름")
})
Expand Down Expand Up @@ -55,9 +54,9 @@ public Response<List<ChatRoomMetaDataInfoResponse>> chatRoomsList(
}

@DeleteMapping
@Operation(summary = "채팅방 삭제", description = "해당 사용자가 지정한 채팅방을 삭제한다")
@Operation(summary = "채팅방 삭제", description = "해당 사용자가 지정한 채팅방을 삭제 API")
@Parameters({
@Parameter(name = "romId", description = "삭제하려는 Chat Room Id", example = "1"),
@Parameter(name = "roomId", description = "삭제하려는 채팅방 고유 NO", example = "1"),
})
public Response<Void> deleteChatRoom(@RequestParam String roomId) {
chatRoomService.deletRoom(roomId);
Expand Down
28 changes: 27 additions & 1 deletion src/main/java/com/petmatz/api/pet/PetController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,21 @@ public Response<PetInfoResponse> fetchPetInfo(@RequestBody PetRegisterNoRequest
// 댕댕이 정보 등록
@PostMapping("/register")
@Operation(summary = "반려동물 등록", description = "사용자의 반려동물 정보를 등록합니다.")
@Parameters({
@Parameter(name = "id", description = "뭔지 모르겠음", example = "?"),
@Parameter(name = "dogRegNo", description = "강아지 등록 넘버", example = "12341512"),
@Parameter(name = "ownerNm", description = "반려견 주인 이름", example = "홍길동"),
@Parameter(name = "petName", description = "반려견 이름", example = "예삐"),
@Parameter(name = "breed", description = "반려견 견종", example = "셰퍼드"),
@Parameter(name = "gender", description = "반려견 성별", example = ""),
@Parameter(name = "neuterYn", description = "중성화 여부", example = ""),
@Parameter(name = "size", description = "반려견 사이즈", example = ""),
@Parameter(name = "age", description = "반려견 나이", example = "12"),
@Parameter(name = "temperament", description = "반려견 성격", example = "차분한"),
@Parameter(name = "preferredWalkingLocation", description = "선호 장소", example = "공원"),
@Parameter(name = "profileImg", description = "반려견 사진", example = "홍길동 or 빈값"),
@Parameter(name = "comment", description = "간단 설명", example = "산책을 좋아합니다."),
})
public Response<S3ImgDataResponse> registerPet(@RequestBody PetRequest request) throws MalformedURLException {
Long userId = jwtExtractProvider.findIdFromJwt();
User user = userUtils.findUser(userId);
Expand All @@ -57,7 +72,18 @@ public Response<S3ImgDataResponse> registerPet(@RequestBody PetRequest request)
// 댕댕이 정보 수정
@PutMapping("/{id}")
@Operation(summary = "반려동물 정보 수정", description = "기존 반려동물 정보를 수정합니다.")
@Parameter(name = "id", description = "반려동물 ID", example = "1")
@Parameters({
@Parameter(name = "id", description = "반려동물 고유 NO", example = "1"),
@Parameter(name = "breed", description = "반려견 견종", example = "셰퍼드"),
@Parameter(name = "gender", description = "반려견 성별", example = ""),
@Parameter(name = "petName", description = "반려견 이름", example = "예삐"),
@Parameter(name = "neuterYn", description = "중성화 여부", example = ""),
@Parameter(name = "size", description = "반려견 사이즈", example = ""),
@Parameter(name = "age", description = "반려견 나이", example = "12"),
@Parameter(name = "temperament", description = "반려견 성격", example = "차분한"),
@Parameter(name = "profileImg", description = "반려견 사진", example = "홍길동 or 빈값"),
@Parameter(name = "comment", description = "간단 설명", example = "산책을 좋아합니다."),
})
public Response<S3ImgDataResponse> updatePet(@PathVariable Long id, @RequestBody PetUpdateRequest petUpdateRequest) throws MalformedURLException {
Long userId = jwtExtractProvider.findIdFromJwt();
User user = userUtils.findUser(userId);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/petmatz/api/petmission/PetMissionController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ public Response<List<UserToPetMissionListInfo>> selectPetMissionList() {

@Operation(summary = "멍멍이의 부탁 상태 업데이트", description = "멍멍이의 부탁 상태를 업데이트 하는 API")
@Parameters({
@Parameter(name = "careEmail", description = "맡김이 Email", example = "2"),
@Parameter(name = "receiverEmail", description = "돌봄이 Email", example = "2"),
@Parameter(name = "petMissionId", description = "펫 미션 ID", example = "2"),
@Parameter(name = "missionStatusZip", description = "미션 상태 [ PLG, END ]", example = "PLG"),
})
Expand Down