[오늘의 오류] url에 언더바(_)가 들어가면 안 좋은 api일까?

밀루·2023년 10월 4일
0

괴발개발 개발일지

목록 보기
17/26

봉착한 문제

인터넷을 허가하는 기능을 만들려고 한다. 이때 적절한 api format은 무엇인가?
1. /allow_internet
2. /internetAccess
3. /internet?action=allow

답은 3번이다. 물론 method는 프론트-백간의 약속이니 다른 방식으로 구현하는게 불가능한 것은 아니다. 그렇지만 컨벤션을 따랐을때 코드의 유지보수/가독성이 좋아지는 장점이 있다.

궁금해서 찾아봤다.

api convention

위 링크를 보면
1. 하이픈(-) 금지
2. 언더스코어(_ ) 금지
3. CamelCase, snake_case 금지
4. 동사 금지
처럼 여러 조건들이 붙어있다.

그렇다면 SEO는 무엇일까

SEO

Search Engine Optimization. 검색 엔진 최적화다.
URL 파라미터는 SEO에 영향을 미친다.

https://www.shopify.com/blog/url-parameters

profile
벨로그에 틀린 코드나 개선할 내용이 있을 수 있습니다. 지적은 언제나 환영합니다.

0개의 댓글