Skip to content

API Documentation

minus43 edited this page Oct 30, 2024 · 3 revisions

API 문서(API Documentation)

Category Method URL Parameters Response Auth Required Description
member POST http://localhost:8181/member/login { "nick_name": "user123", "password": "password123", "auto_login": true } success or failed X 사용자 로그인 및 세션 유지
POST http://localhost:8181/member/signup { "nick_name": "user123", "password": "password123", "email": "user@example.com" } success or failed X 새로운 사용자 회원가입
POST http://localhost:8181/member/logout 없음 success or failed O 사용자 로그아웃 및 세션 종료
GET http://localhost:8181/member/valid_id nick_name=user123 existed or able X 아이디 중복 검사
GET http://localhost:8181/member/valid_email email=user@example.com existed or able X 이메일 중복 검사
GET http://localhost:8181/member/valid_password password=password123 success or failed O 현재 비밀번호와 일치하면 성공
GET http://localhost:8181/member/check_login 없음 { "nick_name": "user123", "email": "user@example.com", "mlb_team": null, ... } O 로그인 시 사용자 정보 확인
POST http://localhost:8181/member/modify { "nick_name": "new_user", "password": "new_password123", "email": "new_email@example.com", ... } success or failed O 사용자 정보 수정
DELETE http://localhost:8181/member/delete 없음 success or failed O 회원 탈퇴 기능
kakao GET http://localhost:8181/kakao/signup { "redirectUri": "http://localhost:3000/callback", "auto_login": true } - 카카오 서버에 리다이렉트
GET http://localhost:8181/kakao/code 없음 성공시 서비스 홈페이지 리다이렉트 - 카카오 인증 코드 처리
board GET http://localhost:8181/board/find_all 없음 [ { "board_num": 5, "title": "Sample Post", "content": "This is a post content", "writer": "user123", "reg_date": "2024-10-26T12:29:22.066567", ... } ] - 모든 게시물 조회
POST http://localhost:8181/board/save { "title": "New Post", "content": "Post content here" } success or failed O 새 게시물 등록
DELETE http://localhost:8181/board/delete board_num=5 success or failed O 특정 게시물 삭제
PUT http://localhost:8181/board/modify { "board_num": 5, "title": "Updated Post", "content": "Updated content" } success or failed O 특정 게시물 수정
PUT http://localhost:8181/board/view board_num=5 success or failed X 조회수 올리기
POST http://localhost:8181/board/like board_num=5 success or failed O 좋아요
DELETE http://localhost:8181/board/unlike board_num=5 success or failed O 좋아요 취소
GET http://localhost:8181/board/like_status board_num=5 success or failed O 좋아요 상태 조회
reply GET http://localhost:8181/reply/find_all board_num=5 [ { "reply_num": 16, "board_num": 5, "content": "This is a reply", "writer": "user123", ... } ] - 특정 게시물의 모든 댓글 조회
POST http://localhost:8181/reply/save { "board_num": 5, "content": "Reply content" } success or failed O 특정 게시물에 댓글 추가
PUT http://localhost:8181/reply/modify { "reply_num": 16, "content": "Updated reply content", "writer": "user123" } success or failed O 특정 댓글 수정
DELETE http://localhost:8181/reply/delete reply_num=16 success or failed O 특정 댓글 삭제
POST http://localhost:8181/reply/like reply_num=16 success or failed O 좋아요
DELETE http://localhost:8181/reply/unlike reply_num=16 success or failed O 좋아요 취소
GET http://localhost:8181/reply/like_status board_num=5 { "liked_replies": [16, 17, 18] } O 좋아요 상태 조회

Clone this wiki locally