🐹

API 명세서

Search
상태
API ID
API 분류
API 명칭
설명
method
URL
카카오 로그인
우선순위
비고
담당자
게스트 연동 완료
MEMBER-01
auth
회원가입 / 로그인 (고민 중)
Open
로그인을 한다.
POST
/api/auth/login/{type}
상
바뀔 수도 있음
연동 및 테스트 필요
MEMBER-02
auth
카카오 계정 전환
Open
게스트 계정을 카카오 계정으로 전환한다.
POST
/api/auth/connect
시작 전
MEMBER-03
auth
로그아웃
Open
로그아웃을 한다.
GET
/api/auth/logout
중
완료
MEMBER-04
member
내 정보 조회
Open
내 회원정보를 조회한다.
GET
/api/members
중
완료
MEMBER-05
member
내 정보 수정
Open
내 회원정보를 수정한다.
PATCH
/api/members
중
완료
MEMBER-06
member
회원탈퇴
Open
회원탈퇴를 한다.
DELETE
/api/members
하
완료
SCHEDULE-01
schedule
일정 등록
Open
새 일정을 등록한다.
POST
/api/schedules
상
연동 및 테스트 필요
SCHEDULE-02
schedule
일정 자동 등록
Open
자연어 일정을 인식하여 등록한다.
POST
/api/schedules/recognize
상
시간 인식 실패 시: 오늘 하루종일 장소 인식 실패 시: (없음)
완료
SCHEDULE-03
schedule
일정 목록 조회
Open
기간 내의 일정 요약 정보를 조회한다.
GET
/api/schedules
상
- 조회하고 싶은 기간의 시작일, 종료일을 쿼리스트링으로 받아오기 - 시작일=종료일이면 그 날짜 일정만
완료
SCHEDULE-04
schedule
일정 세부 조회
Open
해당 일정의 세부 정보를 조회한다.
GET
/api/schedules/{scheduleId}
상
완료
SCHEDULE-05
schedule
일정 수정
Open
해당 일정을 수정한다.
PATCH
/api/schedules/{scheduleId}
중
반복 관련 수정 불가 null
완료
SCHEDULE-06
schedule
일정 삭제
Open
해당 일정을 삭제한다.
DELETE
/api/schedules
중
시작 전
SCHEDULE-07
schedule
패션 추천 (미완)
Open
완료
SCHEDULE-08
schedule
일정 카테고리 목록
Open
일정 카테고리 목록 리스트를 조회한다.
GET
/api/schedules/categories
중
완료
SCHEDULE-09
schedule
소요 시간 계산
Open
도착지까지의 시간을 계산한다.
POST
/api/schedules/route
중
대중교통/도보/자가용 인지 받아와야함 약속시간 2시간 전 기준으로
연동 및 테스트 필요
SCHEDULE-10
schedule
일정 통계
Open
일별 / 월별 통계를 제공한다.
GET
/api/schedules/statistics
하
연동 및 테스트 필요
SCHEDULE-11
schedule
일정 대시보드
Open
(메인화면) 오늘 일정 정보를 제공한다.
GET
/api/schedules/summary
중
진행 중
NOTIFICATION-01
notification
알림………… (미완)
Open
하
완료
GIFTICON-01
gifticon
기프티콘 등록
Open
새 기프티콘을 등록한다.
POST
/api/gifticons
중
완료
GIFTICON-02
gifticon
기프티콘 상세 조회
Open
기프티콘을 조회한다.
GET
/api/gitficons/{gifticonId}
중
완료
GIFTICON-03
gifticon
기프티콘 목록 조회
Open
기프티콘 목록을 조회한다.
GET
/api/gitficons
중
완료
GIFTICON-04
gifticon
기프티콘 수정
Open
기프티콘을 수정한다.
PATCH
/api/gifticons/{gifticonId}
하
완료
GIFTICON-05
gifticon
기프티콘 삭제
Open
기프티콘을 삭제한다.
DELETE
/api/gifticons/{gifticonId}
하
시작 전
GIFTICON-06
gifticon
기프티콘 사용지점 목록
Open
기프티콘 사용지점을 조회한다.
GET
/api/gifticons/nearby
중
지점 위치, 거리 등 반환
완료
PLACE-01
place
사용자 장소 등록
Open
사용자 장소를 등록한다.
POST
/api/places
중
완료
PLACE-02
place
사용자 장소 목록 조회
Open
사용자가 등록한 장소 목록을 조회한다.
GET
/api/places
중
완료
PLACE-03
place
사용자 장소 단일 조회
Open
사용자가 등록한 장소를 조회한다.
GET
/api/places/{placeId}
하
완료
PLACE-04
place
사용자 장소 수정
Open
사용자가 등록한 장소를 수정한다.
PATCH
/api/places/{placeId}
하
완료
PLACE-05
place
사용자 장소 삭제
Open
사용자가 등록한 장소를 삭제한다.
DELETE
/api/places/{placeId}
하
완료
docs
서버 상태 체크
Open
GET
/api/health
완료
docs
Swagger
Open
GET
/swagger-ui/index.html