728x90
Rest api url 패턴정의시…
- 대문자 말고 , 소문자로 작명
# 비추!
<https://www.neoport.com/customService>
# 권장!
<https://www.neoport.com/custom-service>
- 언더바 말고 하이픈!
# 비추!
<https://www.neoport.com/custom_service>
# 권장!
<https://www.neoport.com/custom-service>
- url 끝은 /가 없어야 함.
# 비추!
<https://www.neoport.com/custom/>
# 권장!
<https://www.neoport.com/custom>
- 패턴을 계층형으로 하나씩 / 시로 구분하여 …url 패턴으로 해당 url 역할을 한눈에 알아볼수있게
# 비추!
<https://www.neoport.com/getcustoms>
# 권장!
<https://www.neoport.com/customs/depth/service/all>
<https://www.neoport.com/customs/depth/service/create>
<https://www.neoport.com/customs/depth/service/update>
<https://www.neoport.com/customs/depth/service/delete>
- url 에 파일 확장자 노출 x
# 비추!
<https://www.neoport.com/customs/xxx.json>
<https://www.neoport.com/customs/xxx.xml>
# 권장!
<https://www.neoport.com/customs/xxx>
- query parameter 이냐 path parameter 이냐 (일반적으로…)
# 수정, 삭제
<https://www.neoport.com/customs/12345/xxx>
# 검색 ,(상세 검색)
<https://www.neoport.com/customs/depth/service?id=12345&name=xxx>
- HTTP method에 대한 정의
| url | POST | GET | PUT | DELETE |
| /customers | create | get all | batch update | delete all |
| /customer/id | error | 1건검색 | 1건 수행 | 1건삭제 |
| /customers/id/orders | id=xxx인 customer 주문생성 | xxx모든 주문검색 | xxx모든 주문 수중 | xxx모든 주문 삭제 |
항상 말하지만!
내가 정리한 글이 정답은 아니다.
규칙은 팀바팀으로 따로 정의할것이고 혹시나 내가 직접 개발스타트를 끊어야 될상황이라면
요런 규칙들을 참고하면 좋을듯하다. 이것 되에도 구글링하면 많은 규칙들이 있으니 찾아보면 좋을듯 하다.
'Back-end > 기타' 카테고리의 다른 글
| Optional 클래스(2) : ispresent() vs ifpresent() 차이 (0) | 2023.04.11 |
|---|---|
| Optional 클래스(3) : orElse()와 orElseGet() 차이 (0) | 2023.04.11 |
| AI는 과연 어디까지 선을 넘을까? (0) | 2022.12.13 |
| 웹 화면 전체를 회색으로 변하게 하는 가장 효율적인 방법은? (0) | 2022.12.09 |
| AWS KMS 관련 세팅 (0) | 2022.12.07 |