🚀

API 명세서

Search
API 명세서
FUNCTION_NAME
PATH
API
METHOD
개발완료
담당자
API 명세서 템플릿
Open
~/
Member API
Open
회원가입
Open
api/members/signup
member
POST
베이비 섹시
베이비 섹시
로그인
Open
api/members/signin
member
POST
베이비 섹시
베이비 섹시
회원정보 조회
Open
api/members
member
GET
현준 이
현준 이
회원정보 수정
Open
api/members
member
POST
현준 이
현준 이
회원정보 프로필사진 수정
Open
api/members/profile
member
PUT
베이비 섹시
베이비 섹시
회원 탈퇴
Open
api/members
member
DELETE
현준 이
현준 이
이메일 중복 확인
Open
api/members/email/{email}/validation
member
GET
베이비 섹시
베이비 섹시
비밀번호 재설정(비밀번호 알 경우)
Open
api/members/password-change
member
POST
대훈
대훈
비밀번호 재설정 링크 이메일 전송(비밀번호 모를 경우)
Open
api/members/request-password-reset
member
POST
대훈
대훈
비밀번호 재설정(비밀번호 모를 경우)
Open
api/members/password-reset
member
POST
대훈
대훈
비밀번호 재설정 페이지 반환
Open
api/members/password-reset
member
GET
대훈
대훈
비밀번호 재설정 성공 페이지 반환
Open
api/members/password-reset-success
member
GET
대훈
대훈
Google Login API
Open
소셜(구글) 회원가입/로그인
Open
api/google/join?code={구글에서 받은 Auth Code}
Social
POST
베이비 섹시
베이비 섹시
소셜(구글) 로그인 리디렉션
Open
api/google/login-uri
Social
GET
베이비 섹시
베이비 섹시
📌 Image Upload API
Open
이미지 업로드
Open
api/image
image
POST
베이비 섹시
베이비 섹시
📌 Region API
Open
지역 등록
Open
api/regions
region
POST
베이비 섹시
베이비 섹시
지역 목록 조회
Open
api/regions
region
GET
베이비 섹시
베이비 섹시
특정 지역 조회
Open
api/regions/{regionId}
region
GET
베이비 섹시
베이비 섹시
📌 Post API
Open
게시글 등록
Open
api/posts
post
POST
대훈
대훈
전체 게시글 조회
Open
api/posts
post
GET
대훈
대훈
전체 게시글 최신순으로 정렬
Open
api/posts?page=0&size=10&sortBy=createdAt
post
GET
대훈
대훈
전체 게시글 조회수 순으로 정렬
Open
api/posts?page=0&size=10&sortBy=viewCount
post
GET
대훈
대훈
특정 게시글 조회
Open
api/post/{postId}
post
GET
대훈
대훈
특정 게시글 좋아요 토글
Open
api/posts/{postId}/like
post
PUT
대훈
대훈
게시글 삭제
Open
api/posts/{postId}
post
DELETE
대훈
대훈
게시글 수정
Open
api/posts/{postId}
post
PUT
대훈
대훈
📌 Drink API
Open
특산주 등록
Open
api/drinks/registrations
drink
POST
베이비 섹시
베이비 섹시
특산주 신청 목록 조회
Open
api/drinks/registrations?page=0&size=10
drink
GET
베이비 섹시
베이비 섹시
특산주 신청 글 조회
Open
api/drinks/registrations/{registId}
drink
GET
베이비 섹시
베이비 섹시
📌 Comment API
Open
특정 게시글에 댓글 등록(익명 가능)
Open
api/comments
comment
POST
현준 이
현준 이
특정 게시글의 모든 댓글 조회
Open
api/{postId}/comments?page=0&size=10
comment
GET
현준 이
현준 이
특정 게시글의 특정 댓글 수정
Open
api/comments/{commentId}
comment
PUT
현준 이
현준 이
특정 게시글의 특정 댓글 삭제
Open
api/comments/{commentId}
comment
DELETE
현준 이
현준 이
📌 Tag-Follow API
Open
팔로우할 태그 추가
Open
api/tags/follows
tag-follow
POST
현준 이
현준 이
특정 사용자의 태그 팔로우 리스트 조회
Open
api/members/tags/follows
tag-follow
GET
현준 이
현준 이
팔로우한 태그 삭제
Open
api/tags/follows/{followId}
tag-follow
DELETE
현준 이
현준 이
📌 Notification
Open
알림 조회
Open
api/notifications
notification
GET
현준 이
현준 이
특정 알림 조회
Open
api/notifications/{notificationId}
notification
GET
현준 이
현준 이
📌 Declaration
Open
신고글 등록
Open
api/declarations
declaration
POST
베이비 섹시
베이비 섹시
전체 신고글 조회
Open
api/declarations?page=0&size=10
declaration
GET
베이비 섹시
베이비 섹시
특정 신고글 조회
Open
api/declarations/{declarationId}
declaration
GET
베이비 섹시
베이비 섹시
📌 Suggest API
Open
메인 화면 특산주 추천(위치 갱신)
Open
api/suggest/drink?lat={위도값}&lon={경도값}
suggest
GET
대훈
대훈
홈 화면 이동 시 기존 위치 기준 특산주 추천(위치 미갱신)
Open
api/suggest/drink/current
suggest
GET
대훈
대훈
사용자 생일 기준 추천 특산주 메일 전송
Open
api/suggest/birthday-suggestion
suggest
GET
대훈
대훈
사용자 특정 날짜 생일 특산주 메일 전송
Open
api/suggest/birthday-suggestion/custom?customDate={YYYY-MM-DD}
suggest
GET
대훈
대훈
매월 추천 특산주 메일 전송
Open
api/suggest/monthly-suggestion
suggest
GET
대훈
대훈
인기 상위 태그 중 랜덤 반환
Open
api/suggest/tags
suggest
GET
대훈
대훈
인기 상위 특산주 중 랜덤 반환
Open
api/suggest/drinks
suggest
GET
대훈
대훈
📌 Search API
Open
태그로 게시글 검색
Open
api/search/post/tags?page=0&size=10
search
POST
베이비 섹시
베이비 섹시
검색어로 게시글 검색
Open
api/search/post/drinks?drink=서울특산주&page=0&size=10
search
POST
베이비 섹시
베이비 섹시
특산주 검색
Open
api/search/drinks?regionId=1&drinkName=서울
search
GET
베이비 섹시
베이비 섹시
📌 AutoComplete API
Open
게시글 검색 시 태그 자동완성
Open
api/auto-complete/tag?name=맛
AutoComplete
GET
베이비 섹시
베이비 섹시
게시글 검색시 특산주 자동완성(전국)
Open
api/auto-complete/drink?name=부
AutoComplete
GET
베이비 섹시
베이비 섹시
특산주 검색시 특산주 자동완성(지역별)
Open
api/auto-complete/region-drink?regionId=1&name=서울
AutoComplete
GET
베이비 섹시
베이비 섹시
📌 Manager API
Open
특산주 등록 승인
Open
api/manager/registrations/{registId}/approve
manager
PUT
베이비 섹시
베이비 섹시
특산주 등록 반려
Open
api/manager/registrations/{registId}/cancel
manager
PUT
베이비 섹시
베이비 섹시
신고글 승인
Open
api/manager/declarations/{declarationId}/approve
manager
PUT
베이비 섹시
베이비 섹시
신고글 반려
Open
api/manager/declarations/{declarationId}/cancel
manager
PUT
현준 이
현준 이
📌 Announcement API
Open
공지사항 업로드
Open
api/announcements
Announcement
POST
현준 이
현준 이
공지사항 전체 조회
Open
api/announcements
Announcement
GET
현준 이
현준 이
특정 공지사항 조회
Open
api/announcements/{announcementId}
Announcement
GET
현준 이
현준 이
공지사항 수정
Open
api/announcements/{announcementId}
Announcement
PUT
현준 이
현준 이
공지사항 삭제
Open
api/announcements/{announcementId}
Announcement
DELETE
현준 이
현준 이
📌 ENUM Type
Open
주종(사용자 테이블: favor_drink, 특산주 테이블: type)
Open
Response SOJU, BEER, LIQUOR, MAKGEOLLI, DONGDONGJU, CHEONGJU, YAKJU, FRUIT_WINE, LIQUEUR, DISTILLED_SPIRITS, GAOLIANG, FOLK, WHISKEY, BRANDY, RUM, GIN, VODKA, TEQUILA, WINE, CHAMPAGNE, SAKE, OTHER
사용자 역할(사용자 테이블: role)
Open
Response USER, MANAGER
글 종류(게시글 테이블: type)
Open
Response AD, REVIEW
알림 종류(알림 테이블: type)
Open
Response FOLLOW: 팔로우한 태그로 글 작성됨 → 이때 post_id = 게시글ID COMMENT: 내 글에 댓글 달림(ON/OFF) → 이때 post_id = 게시글ID DECLARATION: 내 신고가 처리되었을때 → 이때 post_id = NULL REGISTRATION: 내 특산주 신청이 처리되었을때 → 이때 post_id = 신청글ID REMOVED: 내 글이 신고되어 삭제되었을때 → 이때 post_id = NULL REJECTION: 신고가 반려 되었을 때 → 이때 post_id = 신고ID
신고 종류(신고 테이블: type)
Open
Response ILLEGAL_INFORMATION: 불법, 사기, 위법 행위 관련 사유 PERSONAL_INFORMATION_EXPOSURE: 개인정보 노출 사유 OBSENE: 음란성/선정성 사유 PROFANE_LANGUAGE: 비속어 사용 사유 SPAMMING: 반복적인 게시글 도배 사유 COPYRIGHT_INFRINGEMENT: 저작권자 허가 없이 게시글 게시한 사유 OTHER: 기타 신고 사유
신고 반려
Open
Response POST_DELETED_BY_USER: 신고한 회원의 게시글이 삭제되어서 존재하지 않음 NOT_RELEVANT: 신고 내용이 게시글과 관련이 없음 MISUNDERSTANDING: 신고자가 오해하거나 잘못 해석한 옳지 않은 신고 NOT_ENOUGH_DETAILS: 신고 사유에 대한 구체적인 설명 부족 DUPLICATE_REPORT: 의미없는 반복된 신고