IT 개발 관련/[프로젝트]

[예약구매] API 문서 작성

Baileyton 2024. 6. 20. 17:45
728x90
  • 내용: 각 API의 요청 방식(GET, POST, PUT, DELETE 등), 엔드포인트, 요청 파라미터, 응답 예시 등을 포함합니다.
  • 목적: API를 통해 어떤 작업을 할 수 있는지, 어떤 데이터를 주고받을 수 있는지 명확히 설명합니다.
기능 Method URL Request Response
회원가입 POST /api/signup email : String
password : String
username : String
phone : 
address :

 
이메일 인증(고민)     email : String
passowrd : String
인증번호
로그인 POST /api/login    
비밀번호 변경 PUT /api/update-password password : String
newpassword : String
 
프로필 변경 PUT /api/update-profile    
상품 조회 GET /api/products    
상품 상세 조회 GET /api/products/{id}    
상품 구매 조회 GET /api/reservations    
상품 구매 상세 조회 GET /api/reservations/{id}    
상품 결제 POST /api/order    
상품 구매 취소 DELETE /api/order/{id}    

 

아직 수정 보완이 필요하다..

728x90