Code&Data Insights

[Backend] URL Convention - URL 주소는 kebab-case와 소문자로 구성하기 본문

Web Development

[Backend] URL Convention - URL 주소는 kebab-case와 소문자로 구성하기

paka_corn 2024. 7. 29. 11:23

백엔드에서 API개발할때 camelCase로 썼는데,, 

kebab-case가 컨벤션인 것을 알게되었다..

기본적인 것이지만 기록해두기!!!

/user/userWalletDetail 이런 네이밍은 안됨! 

 

URL 주소는 kebab-case && 소문자 사용해야함!! 

https://www.theserverside.com/blog/Coffee-Talk-Java-News-Stories-and-Opinions/Why-you-should-make-kebab-case-a-URL-naming-convention-best-practice

 

Why you should make kebab case a URL naming convention best practice

They say there are only two difficult challenges in the world of computer programming: Synchronizing the invalidation of a distributed tertiary and quaternary cache; and What to name things. Given the number of problems I encountered when perusing the Inte

www.theserverside.com

 

  • Never include spaces;
  • Never include special characters;
  • Don’t use camel case;
  • Don’t use snake case;
  • And never, ever use screaming snake case

 

==> Bad Examples 

www.example.com/this_is/a_bad/url_name //snake case
www.example.com/ThisIs/aBad/URLName    //camel case
www.example.com/DO_NOT/EVER_DO/THIS    //SCREAMING_SNAKE_CASE
www.example.com/this is/going 2/cause problems  //using spaces

 

==> Good Example

www.example.com/this-is/a-nice/url-name //kebab case

 

URL 명명 규칙이 중요한 이유?

1) 많은 브라우저와 파일 시스템(특히 Windows 기반)은 대소문자를 구분하지 않음 

2) 구버전 브라우저나 일부 오래된 시스템은 대소문자 변환 또는 경로 자동 수정을 지원하지 않음

3) 검색 엔진은 일관된 URL 구조를 선호

4) REST API의 엔드포인트나 마이크로서비스 URL은 명확하고 예측 가능해야 함

Comments