API 컨벤션(REST API)
- 주소는 소문자로 통일
- API 주소는 복수형으로
api/users
- 동사보다는 명사를 사용
api/getUsers→ api/users
- 주소가 길어진다면 하이픈(-)을 이용하여 구분
api/cosmetics-recommend
- URI 마지막에는 슬래시(/)를 붙히지 말 것.
작성 규칙
- RequestBody와 ResponseBody 모두
JSON 형식을 사용
- 파라미터에 대한 추가 설명이 필요하다면 설명 란에 작성
- 키 이름은
lowerCamelCase 형태로 작성
API 명세