-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
🚀 이슈 설명 (Issue Description)
- 지금까지 만들었던 API를 Swagger 문서로 구현하
🔍 구현 상세 (Implementation Details)
- restaurant.controller
- 레스토랑 추가하기 API: requestBody에 restaurant_name, restaurant_address, latitude, longitude를 넣을 수 있도록 하였고 responseBody에 created_at을 추가하여 언제 추가했는지 알 수 있도록 함
- 특정 레스토랑의 리뷰 목록 조회하기 API: path parameter를 사용하기에 responseBody만 응답되도록 함
- mission.controller
- 레스토랑에 미션 추가하기 API: requestBody에 title, description, reward를 요청할 수 있도록 함, 요청이 성공하면 mission_id, restaurant_id 응답을 추가로 받음
- review.controller
- 미션을 완료하여 리뷰를 등록하는 API: requestBody에 user_id, mission_id, content, rating, photo를 요청, 요청에 성공하면 review_id, restaurant_id 응답을 추가로 받음
- 내가 쓴 리뷰 목록 조회하기 API: 요청 파라미터어에 페이지네이션용 커서와 한 번에 가져올 리뷰 개수를 요청할 수 있게 함, 응답 파라미터에는 다음 페이지 호출을 위한 커서를 추가
- user_mission.controller
- path parameter에는 미션 ID, 요청 파라미터에는 사용자 ID를 요청하면 user_mission_id, user_id, mission_id, status, started_at을 응답으로 받음
- 진행 중인 미션 조회하기 API: user_id, 페이지네이션을 위한 커서, 가져올 미션 개수를 요청할 수 있게 함, 마찬가지로 응답 파라미터에는 다음 페이지 조회를 위한 커서 값을 응답으로 받음
📋 관련 자료 (Related Resources)
- 기능 구현에 참고할 자료(링크, 문서 등)가 있다면 여기에 첨부해주세요.
📌 체크리스트 (Checklist)
- 스웨거 문서가 잘 작성 되었는가?
- 성공 응답과 에러 응답이 잘 받아와지는가?
📝 추가 정보 (Additional Information)
- 기능과 관련하여 추가적으로 고려해야 할 사항이나 특별한 요구사항이 있다면 여기에 작성해주세요.
Metadata
Metadata
Assignees
Labels
No labels