[정리] REST API 규칙

API를 만들다 보면 어떻게 명명할지가 은근히 고민이 많이 된다.

REST API규칙들을 지키다보면 고민을 덜 수 있으니 규칙을 알아봤다.

REST에 대해서는 이전에 간단하게 정리해놨다.

[정리] REST API

1. 소문자

URI를 작성할 때에는 소문자로 작성한다.

Good

http://localhost/good

Bad

http://localhost/Good

2. 언더바 대신 하이픈 사용

언더바는 잘 안보일 수 있기 때문에 하이픈을 사용한다.

Good

http://localhost/good-game

Bad

http://localhost/bad_game

3. URI의 마지막에는 / (슬래시) 를 포함하지 않는다.

웹에서는 마지막에 슬래시가 있는것과 없는것을 같다고 취급하는 경우가 많다.

Good

http://localhost/good

Bad

http://localhost/bad/

4. 계층관리는 슬래시로 구분한다.

자원 간의 계층적 관계를 나타내기 위해 슬래시로 구분해준다.

Good

http://localhost/user/1

Bad

http://localhost/user1

5. 파일 확장자는 URI에 포함하지 않는다.

URI가 아닌 헤더의 Content-Type 이나 다른 방법으로 확장자를 나타내야 한다.

Good

http://localhost/picture

Bad

http://localhost/picture.jpg

6. 자원의 명사를 사용해야 하지만 예외적으로 컨트롤 자원인 경우 동사도 허용

Good

http://localhost/user/write

Bad

http://localhost/user/writing

7. 영어는 복수형으로 작성한다.

Good

http://localhost/users

Bad

http://localhost/user

 

참고

7 Rules for REST API URI Design - DZone