본문 바로가기

Study/개발일지

[spr] Spring 심화주차 level 4 문서 작성

- erd

- api 명세서 

분류 기능 메소드 url request Response
사용자관리 회원가입 Post /user/signup username(사용자명), password(비밀번호), isAdmin(관리자여부)
성공여부 : "success",
msg: "회원가입 성공"

로그인 Post /user/login username(사용자명), password(비밀번호),
관리자 토큰

성공여부 : "success",
msg: "로그인 성공"

로그아웃 Post /user/logout 엑세스 토큰 정보
성공시
"로그아웃 성공"
메시지 호출 실패 시 실패 코드 및 메시지 호출
토큰재발급 Post /user/reissue UserRequestDto.Reissue ( refresh, access 토큰 정보) 성공 시 Token 정보가 갱신되었습니다. 메시지 호출 
실패시 토큰 정보가 일치하지 않습니다 메시지 호출
회원탈퇴 Delete /user/leave 현재 인증된 사용자 정 성공 시 회원탈퇴를 완료하였습니다. 메시지 호출 실패 시 에러메시지 호출
게시글 게시글 작성 Post /boards/posts postDto(게시글 정보), UserDetailsImpl(인증된 사용자정보)
성공하면
게시글을 Client 로 반환
실패 시 에러메시지 호출
게시글 목록 조회 Get /boards/postlist int page,(페이지번호)
int size,(게시글수)
String sortBy,(정렬기준컬럼)
boolean isAsc,(오름차순,내림차순정렬여부)
UserDetailsImpl(사용자정보 인증된)

성공하면
게시글을 Client 로 반환
실패시
에러메시지 호출
카테고리별 게시글 목록 조회  Get /boards/postlist/categories int page,(페이지번호)
int size,(게시글수)
String sortBy,(정렬기준컬럼)
boolean isAsc,(오름차순,내림차순정렬여부),
categoryName 카테고리명


성공하면
게시글을 Client 로 반환
실패시
에러메시지 호출
게시글 상세 조회 Get /boards/posts/{id} 게시글id
성공여부 메세지 반환,
게시글 및 게시글의 댓글을 Client로 반환

게시글 수정 Put /boards/posts/{id} postDto(게시글 정보), UserDetailsImpl(인증된 사용자정보)
성공하면
게시글을 Client 로 반환
실패시
에러메시지 호출
게시글 삭제 Delete /boards/posts/{id} 게시글id
성공여부 메세지 반환,
 실패시 메시지 반환
좋아요

게시글좋아요 Post /boards/posts/likes PostLikeRequestDTO(유저id, 게시글id) 게시글 좋아요 값 1증가 ,
좋아요 테이블에 데이터 저장,
성공여부 메시지 반환
게시글좋아요취소 Delete /boards/posts/likes PostLikeRequestDTO(유저id, 게시글id) 게시글 좋아요 값 1감소 ,
좋아요 테이블에 데이터 삭제,
성공여부 메시지 반환
댓글 좋아요 
 
댓글좋아요 Post /boards/posts/comments/likes CommentLikeRequestDTO(유저id, 댓글id) 댓글 좋아요 값 1증가 ,
좋아요 테이블에 데이터 저장,
성공여부 메시지 반환
댓글좋아요취소 Delete /boards/posts/comments/likes CommentLikeRequestDTO(유저id, 댓글id) 댓글 좋아요 값 1감소 ,
좋아요 테이블에 데이터 삭제,
성공여부 메시지 반환
댓글 댓글 등록 Post /boards/posts/{ post_id }/comments  UserDetailsImpl userDetails(유저 정보), @RequestBody CommentRequestDto requestDto(댓글 정보), @PathVariable Long post_id(게시글id) 성공여부 메세지 반환,
댓글을 Client로 반환
댓글 수정 Put /boards/posts/comments/{id} UserDetailsImpl userDetails(유저 정보), @RequestBody CommentRequestDto requestDto(댓글 정보), @PathVariable Long post_id(게시글id) 성공여부 메세지 반환,
댓글을 Client로 반환
댓글 삭제 Delete /boards/posts/comments/{id} UserDetailsImpl userDetails(사용자정보), @PathVariable Long id(댓글id), @PathVariable Long post_id(게시글id) 성공여부 메세지 반환,성공 혹은 실패 message 반환
728x90