Skip to content
kwon204 edited this page Feb 24, 2025 · 10 revisions

📌 API 명세서

1️⃣ 개요

이 문서는 [언제만나]의 API 명세를 정의합니다.

2️⃣ 공통 정보

  • Base URL: https://unjemannsa.site/api/v1
  • 응답 포맷: JSON
  • 인증 방식: Bearer Token

3️⃣ API 목록

0. 사용자 정보

  • /user/current GET 현재 로그인한 유저의 정보를 받아옵니다.
  • /user/name PATCH 현재 로그인한 유저의 이름을 변경합니다.

1. 인증

  • /login POST 사용자가 로그인합니다.

2. 메인 화면

  • /schedules/upcoming GET 사용자의 다가오는 공유 일정을 조회합니다.
  • /schedules/finished GET 사용자의 지난 공유 일정을 조회합니다.
  • /schedules/ongoing GET 사용자의 확정되지 않은 일정을 조회합니다.

3. 개인 일정 관리

  • /personal-event GET 사용자의 개인 일정을 주 단위로 조회합니다.
  • /personal-event POST 새로운 개인 일정을 추가합니다.
  • /personal-event/{personalEventId} PUT 기존 개인 일정을 수정합니다.
  • /personal-event/{personalEventId} DELETE 기존 개인 일정을 삭제합니다.

4. 논의(일정 조율) 관련

  • /discussion POST 새로운 논의를 생성합니다.
  • /discussion/{discussionId} GET 논의 기본 정보를 조회합니다.
  • /discussion/{discussionId}/invite GET 논의 초대장에 필요한 정보를 조회합니다.
  • /discussion/{discussionId}/join POST 사용자가 논의 초대에 수락합니다.
  • /discussion/{discussionId}/participants GET 논의 참여자들의 정보를 조회합니다.
  • /discussion/{discussionId}/candidate-event/calendar POST 계산된 후보 일정들을 캘린더 뷰로 조회합니다.
  • /discussion/{discussionId}/candidate-event/rank POST 계산된 후보 일정들을 순위 뷰로 조회합니다.
  • /discussion/{discussionId}/candidate-event/details POST 하나의 후보 일정의 상세 정보를 조회합니다.
  • /discussion/{discussionId}/confirm POST 주도자가 후보 일정 중 하나를 공유 일정으로 확정합니다.
  • /discussion/{discussionId}/shared-event GET 확정된 공유 일정을 조회합니다.
  • /discussion/{discussionId}/role GET 유저가 현재 논의의 주도자인지 확인합니다.

Clone this wiki locally