mtak0235 / SYRoom

0 stars 0 forks source link

API 문서 작성 #3

Open mtak0235 opened 2 months ago

mtak0235 commented 2 months ago

REST API 명세

1. 사용자 관리 API

1.1 회원가입

1.2 로그인

2. 보관 공간 API

2.1 보관 공간 등록

2.2 보관 공간 검색

3. 보관 요청 API

3.1 보관 요청 생성

3.2 보관 요청 수락

4. 결제 및 보증금 API

4.1 결제 생성

4.2 보증금 설정

공통 에러 응답 형식

모든 API는 오류 발생 시 다음과 같은 형식으로 응답합니다:

주요 에러 코드

API별 주요 예외 사항

1. 사용자 관리 API

1.1 회원가입
1.2 로그인

2. 보관 공간 API

2.1 보관 공간 등록
2.2 보관 공간 검색

3. 보관 요청 API

3.1 보관 요청 생성
3.2 보관 요청 수락

4. 결제 및 보증금 API

4.1 결제 생성
4.2 보증금 설정
mtak0235 commented 2 months ago

TODO: Spring RestDocs로 관리