체인의정석

rest api 짜기 ) get 에 대하여 본문

개발/backend

rest api 짜기 ) get 에 대하여

체인의정석 2021. 10. 14. 15:46
728x90
반응형

get 자체에는 이미 조회의 의미가 담겨 있으므로 api 설계시에 포함시키지 않는다.

애초에 조회라는 행위에만 쓰이므로 동사형이 오지 않는다.

따라서 명사형을 사용하여 설계 한다. 리소스 명이 들어가야 한다.

 

또한 get의 경로에 입력값을 포함시키는것도 일반적이기 때문에, 경로에 입력값을 넣는것도 좋다.

 

또한 input의 종류는 상황에 따라서 다르게 한다.

 

조회를 한다고 무조건 get을 사용하는것은 아니며 상세한 쿼리문이 들어갈 경우 post를 사용하기도 한다.

이럴 경우 복잡한 조회는 /search 를 post에 넣어주는 방법이 있다.

 

url " / "는 계층관계를 의미하며 마지막에는 사용하지 않는다. 또한 문서하나인지 집합인지를 구분하여 복수, 단수도 적용해서 작성해야 한다.

 

_ 보다는 - 를 사용하는것이 일반적이다.

 

확장자는 경로에 포함하지 않는다.

 

 

 

 

728x90
반응형
Comments