HomeAboutMeBlogGuest
© 2025 Sejin Cha. All rights reserved.
Built with Next.js, deployed on Vercel
♥️
2기 최종 프로젝트 팀별 공간/
🐳
[팀 07] 머구리(Meoguri)/
✨
API document
✨

API document

OAuth2로그인 + 프로필 여부 조회 Flow

Response Status Code

성공 상태 코드

  • 200 OK

예외 상태 코드

  • 400 BAD REQUEST
  • 401 UNAUTHORIZED
  • 404 NOT FOUND

서버 오류 상태 코드

  • 500 Intenal Server Error

Error Response Body

{
	"code" : 400
	"message" : "잘못된 요청입니다"
}
 
Auth (JWT Token 방식 이용) 
HEADER

Authorization : "Bearer {{jwt-token}}"
 

API Prefix

모든 API 앞에 /api/v1/ 을 붙여주세요!
ex) /api/v1/bookmarks
 

도메인 담당

하하 - 알림,팔로우
제이곱 - 리액션, 즐겨찾기
크러쉬 - 북마크
하니 - 프로필
 
북마크
Description
URL Patterns
Method
개발 여부
사용 가능여부
북마크 등록
/bookmarks
POST
개발 여부
사용 가능여부
북마크 수정
/bookmarks/{bookmarkId}
PUT
개발 여부
사용 가능여부
북마크 삭제
/bookmarks/{bookmarkId}
DELETE
개발 여부
사용 가능여부
북마크 상세 조회
/bookmarks/{bookmarkId}
GET
개발 여부
사용 가능여부
내 북마크 목록 조회
/bookmarks/me
GET
개발 여부
사용 가능여부
다른 사람 북마크 목록 조회
/bookmarks/others/{profileId}
GET
개발 여부
사용 가능여부
피드 북마크 목록 조회
/bookmarks/feed
GET
개발 여부
사용 가능여부
링크메타데이터 요청
/linkmetadatas/obtain?link=?
POST
개발 여부
사용 가능여부
url 중복 확인 요청
/bookmarks?url=?
GET
개발 여부
사용 가능여부
북마크 즐겨찾기
/bookmarks/{bookmarkId}/favorite
POST
개발 여부
사용 가능여부
북마크 즐겨찾기 취소
/bookmarks/{bookmarkId}/unfavorite
POST
개발 여부
사용 가능여부
 
팔로우
Description
URL Patterns
Method
개발 여부
팔로우 하기
/profiles/follow?followeeId=?
POST
개발 여부
언팔로우 하기
/profiles/unfollow?followeeId=?
POST
개발 여부
리액션
Description
URL Patterns
Method
개발 여부
리액션 요청
/bookmarks/{bookmarkId}/reactions/{reactionType}
POST
개발 여부
프로필
Description
URL Patterns
RestDocs 여부
Method
개발 여부
로그인
/login
RestDocs 여부
POST
개발 여부
로그인 성공(프로필 여부 반환)
/login/success
RestDocs 여부
GET
개발 여부
프로필 등록
/profiles
RestDocs 여부
POST
개발 여부
내 프로필 조회
/profiles/me
RestDocs 여부
GET
개발 여부
프로필 조회
/profiles/{profileId}
RestDocs 여부
GET
개발 여부
팔로우/팔로워 전체 조회
/profiles/{profileId}/{tab}?page=?&size=?&username=?
RestDocs 여부
GET
개발 여부
내 프로필 수정
/profiles/me
RestDocs 여부
PUT
개발 여부
프로필 목록 조회 - 머구리 찾기
/profiles?page=?&size=?&username=?
RestDocs 여부
GET
개발 여부
카테고리
Description
URL Patterns
Method
개발 여부
카테고리 전체 조회
/categories
GET
개발 여부
태그
Description
URL Patterns
Method
개발 여부
사용자 태그 조회
/tags 프로필 조회에 묻어감
GET
개발 여부
알람
이름
URL Patterns
Method
개발 여부
공유 알림 생성
bookmark/{bookmarkId}/share
POST
개발 여부
알림 조회
/notifications?page=?&size=?
GET
개발 여부
 
 
회원탈퇴

Enums - 고정된 String 값들

 
리액션 - type : like, hate
북마크 - openType : all, partial, private
카테고리
  • 자기계발
  • 인문
  • 정치
  • 사회
  • 예술
  • 과학
  • 기술
  • IT
  • 가정
  • 건강
  • 여행
  • 요리
 

정렬

order : like → 좋아요 순
: upload → 업로드 순
(default : upload)