Skip to content

1. EndPoint 리스트

Jong1 edited this page Nov 4, 2023 · 6 revisions

EndPoint

1️⃣ 개요

Note

해당 페이지는 이 프로젝트에서 작성된 EndPoint를 기록하였습니다.

2️⃣ Infra

Note

Infra를 위한 Endpoint입니다

RequestMapping Method Mapping Description
GET /health LB(Load Balancer)에서 서버가 현재 살아있다는 신호를 주기 위한 전용 Endpoint

3️⃣ Auth

Note

인증 및 인가, 회원정보와 관련된 EndPoint 입니다

RequestMapping Method Mapping Description
/auth GET /verifyEmail 회원가입시 발송한 메일을 통한 유효 이메일 확인
GET /oauth/kakao 카카오OAuth 로그인
POST /register 사용자 회원가입
POST /login 로그인
POST /logout 로그아웃
/mypage GET / 로그인한 사용자 정보 취득
GET /mylist/{searchType} 로그인한 사용자의 작성물 리스트 검색
PUT / 사용자 정보 수정
PUT /thumnail 사용자 썸네일 프로필 Path변경

4️⃣ Article

Note

게시물과 연관된 Endpoint리스트 입니다.

RequestMapping Method Mapping Description
/article GET /{articleId} 게시물 단건 조회
GET /list/{boardId} 게시물 리스트 조회
POST / 게시물 등록
PUT / 게시물 수정
DELETE /{articleId} 게시물 삭제
/reply GET /{articleId} 게시물 List조회
POST / 게시물 등록
DELETE / 댓글 삭제
/article/like GET /{articleId} 사용자가 게시물의 좋아요 판단 유무
POST /{articleId} 좋아요 또는 좋아요 취소

5️⃣ Notice

Note

공지사항기능의 EndPoint 입니다.

RequestMapping Method Mapping Description
/notice GET / 공지사항 게시물 리스트 조회
GET /{noticeArticleId} 공지사항 게시물 상세조회
POST / 공지사항 추가
PUT / 공지사항 게시물 수정
DELETE /{noticeArticleId} 공지사항 게시물 삭제

6️⃣ Admin

Note

관리자 기능의 EndPoint 입니다.

RequestMapping Method Mapping Description
/admin GET /account/list/{role} 계정리스트 조회
GET /account/{userId} 사용자 계정 정보 상세 조회
GET /account/article/{userId} 게시물의 상태와 관련없이 해당 사용자가 작성한 모든 게시물을 Page처리해서 반환한다.
GET /account/reply/{userId} 댓글의 상태와 관련없이 해당 사용자가 작성한 모든 댓글을 Page처리해서 반환한다.
POST /register 관리자 계정 추가.
PUT /account/status 계정 상태 변경

7️⃣ Search

RequestMapping Method Mapping Description
/search GET /{word} 특정 단어를 포함하는 제목을 가진 게시글의 목록을 페이징으로 조회한다
GET /all/{word} 특정 단어를 포함하는 제목을 가진 게시글을 조회한다

8️⃣ File

RequestMapping Method Mapping Description
/file POST /images 이미지 리스트 등록
POST /image 이미지 등록