RESTful API💡: URL에 들어가는 파라미터 네이밍

장고로 URL query string을 만드는데..

query string에 들어가는 파라미터의 네이밍

파이썬에서 함수/변수가 두개의 단어로 이루어지는 경우
아래와 같이, 스네이크드 네이밍 룰에 따른다
예) data_kind

그렇다면 쿼리 스트링 파라미터 네이밍은 어떻게?
이 궁금증 해결하러 책읽으러 갑니당
API 디자인🧚‍♀️: REST API Design Rulebook

camalCase를 쓰라고 제시

"REST API Design Rulebook"(2011년 출간)에서는 camalCase를 쓰라고 명시적으로 언급한 문장은 없지만,
query string 예제에서 camalCase를 사용하고 있음!
간접적으로 camalCase를 쓰는 것을 제안한다고 느껴짐!

2011년 출간된 책이고, 참고하는 자료 중 하나이니까
꼭 camalCase를 써야한다는 것은 아니만 일단은 책에서 그렇다!

그렇다면 구글은..?

구글은 쿼리스트링 어찌쓰는가?

https://www.google.com/search?rlz=1C1SQJL_enKR899KR899&biw=1920&bih=937&sxsrf=ALeKk02PAFWe8vSynzK5OZypu0G3v9nn2A%3A1604017511652&ei=Z12bX_-2J4nZhwPn95yoDw&q=query+parameters+camelcase+google&oq=query+parameters+camelcase+google&gs_lcp=CgZwc3ktYWIQAzIHCCEQChCgATIHCCEQChCgATIHCCEQChCgAToECAAQRzoFCAAQyQM6BggAEBYQHjoICCEQFhAdEB46BQghEKABUM3cIFiX5SBg_uUgaABwAngAgAGyAYgBqAeSAQMwLjaYAQCgAQGqAQdnd3Mtd2l6yAEIwAEB&sclient=psy-ab&ved=0ahUKEwi_hvvvhtvsAhWJ7GEKHec7B_U4ChDh1QMIDQ&uact=5

위의 쿼리스트링을 잘 살펴보면
"gs_lcp"라는 쿼리스트링 파라미터 확인가능!
구글은 쿼리스트링 파라미터를 스네이크드로 쓰는 군!

구글SEO를 위해서는 URL에는 언더말고 하이픈

쓰세요!

https://www.i-am-the-server.com/data?kind='weather'

구글 검색엔진이 언더바로 구분된 경우는 하나의 단어로 인식!
반면에,
하이픈으로 구분된 단어는 단어자체로 구분한다고 한다!

결론?!

파라미터 네이밍은 케멀로 쓰는 것이 비공식적? 표준인 것 같으나(REST API룰북 책 예시)
백엔드의 언어에 따라서 코드작성을 용이하기 위해서 편이상 백엔드 언어의 네이밍 룰을 따라가는 것 같음!

장고는 snaked_case
https://i-am-the-server.com/price?product_id=111

• 백엔드에서 위와 같은 api를 호출받으면
• get http request에서 "product_id"가져와서 값을 확인하고
• database에서 product id가 111인 제품을 response http로 돌려준다.
  get htttp request에서 변수?를 가져올때
  백엔드의 네이밍룰과 맞추면 편하기에 그렇게 보통쓰는 것 같다

Reference

• URL에서는 언더바(언더스코어: _)가 나을까 대쉬(-)가 나을까?
• URI에서 단어 구분 기호로 하이픈, 밑줄 또는 낙타 케이스?
• http://www.yes24.com/Product/Goods/5832875?OzSrank=1