REST API 규칙

REST API를 만들때 어떤 점을 주의해야할까? 문득 생각이 들어 찾아보았다. 

앞으로 API를 만드는데 있어 정리해놓고 한 번 참고하면 좋을 것 같다. 

 

 

 

 

1. 마지막에 / 를 포함하지 않는다 

(X) http://api.test.com/users/

(O) http://api.test.com/users

 

 

 

2. underbar 대신에 dash를 사용한다 

(X) http://api.test.com/hello_world

(O) http://api.test.com/hello-world

 

 

3. 소문자를 사용한다 - camelCase 적용X

프로그래밍을 하다보면 camelCase가 익숙하다보니 이걸 RestApi를 설계할때도 반영이 되는 것 같은데, API를 작성할때는 지양하는것이 좋다. 

(X) http://api.test.com/helloWorld

(O) http://api.test.com/helloworld

 

 

4. 행위는 URL에 포함하지 않는다 

(X) POST http://api.test.com/users/1/delete-post/1

(O) DELETE http://api.test.com/users/1/posts/1

 

일단 이정도로 정리를 해봤다. 

 

 

https://library.gabia.com/contents/8339/

가비아 라이브러리

위의 글을 참고하였습니다. 좋은 자료 감사합니다.