API URI 설계시 체크 포인트
- [ ] 슬래시 구분자(
/)는 계층 관계를 나타내는 데 사용한다
- [ ] URI 마지막 문자로 슬래시(
/)를 포함하지 않는다
- [ ] 하이픈(
-)은 URI 가독성을 높이는 데 사용한다
- [ ] 밑줄(
_)은 URI에 사용하지 않는다
- [ ] URI 경로에는 소문자가 적합하다
- [ ] 파일 확장자는 URI에 포함시키지 않는다
API
Socket
{
"eventType": "CREATE_QUESTION" | "LIKE_QUESTION" | "CREATE_ANSWER",
"data": {...//생략}
}
API 문서 변경 Log
- 사용자 정보 수정
- 이름 수정:
회원 정보 수정 → 사용자 정보 수정
- URL 수정:
POST api/auth/update → PUT api/members/me
- 회원 탈퇴 API 수정
- URL 수정: DELETE
api/auth/signout → DELETE api/members/me
- Path Param 이름 변경
cursor → page
- 사용자 패널 가져오기
- URL 수정: GET
api/members/me/panels?cursor → GET api/panels?cursor
- 질문 가져오기
- Path Param 이름 변경
order → sort
- 최신순:
/api/panels/{panelId}/questions?page=0&sort=createdDate,DESC
- 좋아요순 (좋아요가 같으면, 최신순):
/api/panels/{panelId}/questions
api/questions/:questionId/answers