Search

API DOCS

목차

API 목록

catchstudy.com 사이트에서 사용하는 API 목록입니다. 스터디 관리 APISpring 으로 제작하였으며, 그 외 나머지는 Django로 제작되었습니다.

사용자 인증 API (/auth/)

GET ID 중복 체크
GET Email 중복 체크
GET 이름(닉네임) 중복 체크
GET 유효한 JWT 토큰 확인
GET 사용자 로그아웃
GET 인증 이메일 전송
GET 인증 이메일 인증확인
GET 패스워드 초기화 페이지 URL 이메일 전송
POST 패스워드 초기화
POST 사용자 로그인
POST 패스워드 검증

사용자 관리 API (/user/)

GET 사용자 정보 확인
GET 팀원의 이력서 조회
GET 팀원의 프로필 조회
POST 사용자 추가
POST 사용자 신고
PUT 사용자 기본 정보 수정
PUT 사용자 패스워드 변경
DELETE 사용자 삭제

프로필 관리 API (/profile/)

POST 프로필 이미지 업로드
GET 사용자의 기본 정보 조회
GET 사용자의 URL 목록 조회
GET 사용자의 URL 목록에 URL 추가
GET 사용자의 URL 목록에서 URL 삭제
GET 사용자의 스터디 즐겨찾기 목록 조회
GET 사용자의 스터디 즐겨찾기 목록에 스터디 추가
GET 사용자의 스터디 즐겨찾기 목록에서 스터디 삭제
GET 모든 기술 목록 조회
GET 사용자의 기술스택 목록 조회
GET 사용자의 기술스택 목록에 기술 추가
GET 사용자의 기술스택 목록에서 기술 삭제

관리자 API [ 관리용 ]

개발 테스트용으로만 사용되는 API이며, 실 운영 시에서는 삭제되어 서비스 예정
GET 모든 사용자 확인 [ 관리용 ]
GET 로그인한 사용자 ID 확인 [ 관리용 ]

스터디 관리 API (/study/)

GET 스터디 검색
GET 즐겨찾기 목록 조회
GET 스터디 즐겨찾기 추가
GET 스터디 작성자 여부 확인
POST 스터디 참가신청
POST 스터디 생성
POST 스터디 신고
GET 스터디 상세보기
GET 생성한 스터디 확인
GET 스터디 참여현황 조회
GET 신청한 스터디 확인
PUT 스터디 수정
PUT 스터디 참가자 수정
PUT 스터디 모집여부수정
DELETE 스터디 삭제
DELETE 스터디 참가자 삭제
DELETE 신청한 스터디 탈퇴

댓글 관리 API (/study/<int:study_id>/comments)

GET 스터디의 댓글 목록 확인
POST 스터디의 댓글 생성
POST 스터디의 대 댓글 생성
PUT 스터디의 댓글 수정
PUT 스터디의 댓글 가시여부 변경
DELETE 스터디의 댓글 삭제

템플릿

API Docs 작성 시 사용되는 템플릿들 입니다. 필요한 경우 내용 변경 없이 그대로 복사하여 사용 부탁드립니다.
API Docs 작성 양식에 대한 상세한 내용은 아래 페이지에 작성하였습니다.

API DOCS Template

아래 예시는 템플릿을 복사한 후, 반드시 동기화를 해제하여 사용 부탁드립니다. (예시는 동기화 미 해제 시, 템플릿이 변경됨) * 동기화된 블록 동기화 해제법 [ 동기화 블록 ] 우 클릭 → [ ... ] 클릭 → [ 동기화 해제 ] 클릭
GET Example API

각 서비스 별 이름

각 API에서 사용되는 서비스 이름에 대한 내용입니다. 반드시 아래 내용과 동일할때만 복사하여 내용 변경없이 사용해야합니다. 만약 해당 이름에서 값 변경이 필요한 경우 반드시 동기화를 해제하여 사용 부탁드립니다. * 동기화된 블록 동기화 해제법 [ 동기화 블록 ] 우 클릭 → [ ... ] 클릭 → [ 동기화 해제 ] 클릭
동기화 원본 블록

API 서버 주소

Docs의 서버 주소본인의 서버 주소가 작성된 동기화 블록을 복제하면 됩니다.
동기화 원본 블록

쿠키 관련 표

많은 API에서 사용되는 쿠키 관련 내용입니다. 반드시 아래 내용과 동일할때만 복사하여 내용 변경없이 사용해야합니다. 만약 해당 쿠키 값에서 값 변경이 필요한 경우 반드시 동기화를 해제하여 사용 부탁드립니다. * 동기화된 블록 동기화 해제법 [ 동기화 블록 ] 우 클릭 → [ ... ] 클릭 → [ 동기화 해제 ] 클릭
동기화 원본 블록

Error 메세지 관련 표

많은 API에서 사용되는 인증 관련 에러 메세지가 작성된 표입니다. 반드시 아래 내용과 동일할때만 복사하여 내용 변경없이 사용해야합니다. 만약 해당 쿠키 값에서 값 변경이 필요한 경우 반드시 동기화를 해제하여 사용 부탁드립니다. * 동기화된 블록 동기화 해제법 [ 동기화 블록 ] 우 클릭 → [ ... ] 클릭 → [ 동기화 해제 ] 클릭
동기화 원본 블록