기본 url : /api
대분류 | ✅ | 소분류 | 기능 | method | parent url | child url | request body | response body | 비고 |
---|---|---|---|---|---|---|---|---|---|
회원 관리 | ✅ | 회원 인증 | ‣ | POST |
/auth | /join | 닉네임, 이름, 이메일, 학번, 비밀번호 | 닉네임 필수 | |
닉네임 중복 검사, 이메일 중복검사 재진행 |
| | ✅ | | 이메일 인증 | POST
| | /verify-email | | | 이메일 중복 검사 진행 |
| | ✅ | | 회원 인증 | POST
| | /verify-user | 학번, 이름 | | 교수님, 교육프로 학번 0000000 |
| | | | 회원 차선책 인증 | POST
| | /verify-user-alternate | | | 에듀싸피 확인 질문 |
| | ✅ | | 로그인 | POST
| | /login | 이메일, 비밀번호 | | |
| | ✅ | 회원 프로필 조회 | 회원 정보 조회 | GET
| /user | /{id} | | 닉네임, 레벨, 회사, 선호 기술 스택 | |
| | ✅ | 회원 게시글 조회 | 회원 게시글 조회 | GET
| | /{id}/activity | | | 내 게시글은 모두 반환
다른 회원 게시글은 익명 제외 반환 |
| | ✅ | 회원 수정 | 회원 정보 수정 | PATCH
| | /{id} | 닉네임, 프로필사진, 기술스택, 회사 | | |
| | ✅ | | 비밀번호 변경 | PATCH
| | /{id}/password | 현재 비밀번호, 새 비밀번호 | | |
| | ✅ | 알람 | 알람 리스트 조회 | GET
| | /alarm | | | |
| | ✅ | | 알람 수신 여부 변경 | POST
| | /send-alarm | Boolean | | |
| | ✅ | | 알람 확인 | POST
| | /read-alarm | | | |
| | ✅ | 검색 | 회원 검색 | GET
| | /search?word={word} | | | |
| | ✅ | 회원 탈퇴 | 회원 탈퇴 | DELETE
| | - | | | |
| | ✅ | 쪽지 | 쪽지 리스트 조회 | GET
| /user/message | /list | | | 사람들 목록 반환 |
| | ✅ | | 쪽지 상세 조회 | GET
| | /{other_user_id} | | | 특정 유저와 나눈 대화만 반환 |
| | ✅ | | 쪽지 전송 | POST
| | /{to_user_id} | | | |
| | | | 쪽지 삭제 | DELETE
| | /{message_id} | | | |
| | | | | | | | | | |
| 게시판 | ✅ | | 게시글 작성 | POST
| /article | | 보드 정보, 카테고리, 제목, 글, user 익명 여부,tag | | tag list |
| | ✅ | | 게시글 전체 불러오기 | GET
| | /list | | | |
| | ✅ | | 게시판 별로 게시글 전체 불러오기 | GET
| | /list/{board_id} | 보드 정보(자유, 질문, 꿀팁)
보드 1 = 자유, 2=질문, 3=꿀팁 | 게시글 목록(게시글 제목, 작성자, 작성일, 조회수, 좋아요 개수) | |
| | ✅ | | 인기 게시물 리스트 | GET
| | /hot | | | |
| | ✅ | | 인기 게시물 리스트(보드별로) | GET
| | /hot/{board_id} | 보드 정보(자유, 질문, 꿀팁) | 게시글 목록(게시글 제목, 작성자, 작성일, 조회수, 좋아요 개수) | |
| | ✅ | | 게시글 불러오기 | GET
| | /{article_id} | | 게시글 제목, 작성자, 작성일, 조회수, 좋아요 개수, 댓글(or 답변) | |
| | ✅ | | 게시글 수정 | PATCH
| | /{article_id} | | | |
| | ✅ | | 게시글 삭제 | DELETE
| | /{article_id} | | | |
| | ✅ | | 게시글 좋아요 | POST
| | /likes/{article_id} | | | |
| | ✅ | | 게시글 스크랩 | POST
| | /scrap/{article_id} | 게시글 id | | |
| | ✅ | | 댓글 가져오기 | GET
| | /{article_id}/comments/list | | | |
| | ✅ | | 댓글작성 | POST
| | /{article_id}/comments | 게시글 id, 댓글 내용 | | |
| | ✅ | | 댓글 수정 | PATCH
| | /comments/{comment_id} | | | |
| | ✅ | | 댓글 삭제 | DELETE
| | /comments/{comment_id} | | | |
| | ✅ | | 댓글 좋아요 | POST
| | /comments/likes/{comment_id} | | | |
| | | | 대댓글 | POST
| | /article/comment/{comment_id} | 댓글 id, 댓글 내용 | | |
| | | | 태그 검색
(태그로 게시글 검색) | GET
| | /{tag_name} | | | |
| | ✅ | | 게시글 검색 | GET
| | {board_id}/{type}/{search_word} | 서치 단어, 서치 타입(제목=1, 내용=2, 작성자=3) | 게시글 목록(게시글 제목, 작성자, 작성일, 조회수, 좋아요 개수) | |
| | | | 태그 검색(태그 자체) | GET
| /tag | - | 태그 이름 | | |
| | ✅ | 질문 게시판 | 답변 작성 | POST
| article/answer | | 질문 id, 제목, 내용 | | |
| | ✅ | | 답변 수정 | PATCH
| | /{answer_id} | | | |
| | ✅ | | 답변 삭제 | DELETE
| | /{answer_id} | | | |
| | ✅ | | 답변 채택 | PATCH
| | /{answer_id}/select | | | |
| | ✅ | | 답변 가져오기 | GET
| | /{answer_id} | | | |
| | ✅ | | 답변 리스트가져오기 | GET
| | /{article_id}/list | | | |
| | | | 지식인 랭킹 | GET
| | /rank | | | |
| 메인페이지 | | | 통합 검색 | GET
| /main | /search | | | |
| | | | 인기 게시글 검색 | GET
| | /hottest-article | | | |
| | | | 인기 밸런스 게임 검색 | GET
| | /hottest-balance | | | |
| | | | 인기 선호도 조사 검색 | GET
| | /hottest-preference | | | |
| | | | 자유게시판, 질문 게시판, 꿀팁 게시판 최신순 가져오기 | GET
| - | - | | | 게시판 API 참조
Pagination |
| | | | | | | | | | |
| 싸피 놀이터 | ✅ | 밸런스 게임 | 게임 등록 | POST
| /balance | - | 제목, 내용, 옵션 1,2 ( left, right ) | | |
| | ✅ | | 게임 전체 불러오기 | GET
| | /list | | | pagination 적용 |
| | ✅ | | 게임 불러오기 | GET
| | /{balance_id} | | | pagination 적용 |
| | ✅ | | 게임 수정 | PUT
| | /{balance_id} | 제목, 내용 | | |
| | ✅ | | 게임 삭제 | DELETE
| | /{balance_id} | | | |
| | | | 투표 수정 | PUT
| | /{balance_id}/poll | 투표 내용 | | PUT, PATCH 회의 필요 |
| | ✅ | | 투표 하기 | POST
| | /{balance_id}/poll | 내용 ( LEFT || RIGHT ) | | 다른 사용자가 투표 |
| | ✅ | | 게임 결과 반환 | GET
| | /{balance_id}/statistics | | | 비율 반환 |
| | ✅ | | 댓글 생성 | POST
| | /{balance_id}/comments | | | 알림주기 |
| | ✅ | | 댓글 수정 | PATCH
| | /{balance_id}/comments/{comments_id} | | | |
| | | | 댓글 가져오기 | GET
| | /{balance_id}/comments | | | |
| | ✅ | | 댓글 삭제 | DELETE
| | /{balance_id}/comments/{comments_id} | | | |
| | ✅ | | 댓글 좋아요 | POST
| | /{balance_id}/comments/likes/{comments_id} | | | 알림 |
| | | | 검색 | GET
| | /search?search={search} | 제목 | | query param |
| | | | | | | | | | |
| ✅ | ✅ | 선호도 조사 | 전체 불러오기 | GET
| /preference | ?page=1 | | | |
| ✅ | ✅ | | 등록 | POST
| /preference | - | 제목,내용,투표 | | |
| ✅ | ✅ | | 읽기 | GET
| | /{preference_id} | | | |
| ✅ | ✅ | | 수정 | PATCH
| | /{preference_id} | | | |
| ✅ | ✅ | | 삭제 | DELETE
| | /{preference_id} | | | |
| ✅ | ✅ | | 투표 하기/취소하기 | POST
| | /{preference_id}/{preference_options_id} | | | |
| | | | 게임 결과 반환 | GET
| | /{preference_id}/statistics | | | |
| ✅ | ✅ | | 댓글 생성 | POST
| | /{preference_id}/comments | | | |
| ✅ | ✅ | | 댓글 전체 가져오기 | GET
| | /{preference_id}/comments | | | |
| ✅ | ✅ | | 댓글 수정 | PATCH
| | /{preference_id}/comments/{comments_id} | | | |
| ✅ | ✅ | | 댓글 삭제 | DELETE
| | /{preference_id}/comments/{comments_id} | | | |
| ✅ | ✅ | | 댓글 좋아요/취소 | POST
| | /{preference_id}/comments/{comments_id}/like | | | |
| | | | 검색 | GET
| | /search?title={title} | 제목 | | query param |
| | | | 페이징처리 | | | | | | |
| | | | | | | | | | |