rest API 규칙

✅ URI는 정보의 자원을 표현

✅ ****자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현

1. 소문자를 사용한다.

주소에서 대소문자를 구분하므로, 카멜방식이 아닌 소문자를 사용하여 작성한다.

Bad

http://ssafe.com/users/postComments

Good

http://ssafe.com/users/post-comments

2. 언더바를 대신 하이픈을 사용한다.

가급적 하이픈의 사용도 최소화하며, 정확한 의미나 표현을 위해 단어의 결합이 불가피한 경우에 사용한다.

Bad

http://ssafe.com/users/post_comments

Good

http://ssafe.com/users/post-comments

3. 마지막에 슬래시를 포함하지 않는다.

슬래시는 계층을 구분하는 것으로, 마지막에는 사용하지 않는다.

Bad

http://ssafe.com/users/

Good

http://ssafe.com/users

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

행위는 URL대신 Method를 사용하여 전달한다.(GET, POST, PUT, DELETE 등)

Bad

POST http://ssafe.com/users/1/create-posts
DELETE http://ssafe.com/users/1/delete-post/1
PUT http://ssafe.com/users/1/update-post/1

Good

POST http://ssafe.com/users/1/posts
DELETE http://ssafe.com/users/1/posts/1
PUT http://ssafe.com/users/1/posts/1

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

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 말고 Accept header를 사용하도록 한다.

Bad

http://ssafe.com/users/moram.jpg

Good

GET http://ssafe.com/users/moram

HTTP/1.1 Host: ssafe.com Accept: image/jpg

6. 가급적 전달하고자하는 자원의 명사를 사용하되, 컨트롤 자원을 의미하는 경우 예외적으로 동사를 허용한다.

Bad

http://ssafe.com/posts/registering

Good

http://ssafe.com/posts/register