RESTFUL URL 규칙 + 협업시 지켜야 할 것들

 

프로젝트를 진행하며, 혼자 개발 했던 경험과는 큰 차이가 있음을 배우고 있다.

그 과정에서 배웠던, URL 규칙을 정리하고자 한다 .

 

URL 규칙

 

1. 소문자를 사용하자. 

 

대문자는 가끔 문제가 발생되기도 한다. 

 

2. 마지막이 /로 끝내지 않게 하자 

 

3. 동사를 지양하자. 

동사를 사용하면 사용자가 지금 어떤 행위를 하고있는지 직접 확인이 가능하다.  지양하고

GET, POST, PUT , PATCH등을 활용하여 해당 내용을 전달하자

 

4. BACKEND에 관련된 내용인데, REQUESTPARAM과 PATHVARIABLE의 활용엔 고민하자.

사실 둘다 URL의 전달이 목적이 되면, 어떤것을 사용해도 기능상 문제가 되는 경우는

많지 않다 (하지만, PATHVARIABLE은 하나만 가능하다는 단점도 있기는 하다. ) 

 

우리는 기본적인 방식을 REQUESTPARAM으로 진행하기로 약속했다. 

허나, API-GATEWAY를 활용하여 MSA구조로 구축함에 따라, 요청시 EMAIL을 추가하는 동작과정이 있다.

이때 EMAIL은 사용자가 아니라 서버단에서 처리하여 전달한다는 차이를 확실히 명시하기 위해 

PATHVARIABLE로 전달하기로 약속하였다.

 

5. 사용자와, DB관련 내용은 CAMEL 보단 SNAKE CASE를 사용하자.

 

혼자서 개발할땐, 사실 변수를 어떻게 적어도 나만 알면 되기 때문에 크게 문제가 있지는 않았었다.

하지만 이제는 FRONT, BACK 모두에서 우리 팀원들과 소통이 필요했다.

CAMEL보단 SNAKE CASE가 보기 명료하다.

나는 CAMEL이 더 편하지 않나 생각하기도 하였지만.. 그것은 내 개인적인 면이고

협업에 있어서는 상대방을 배려해야한다.