Representational State Transfer 의 약자

REST API 설계

동작 = http method

데이터를 읽고, 추가하고, 수정하고, 삭제하는 동작은 http method를 이용하여 표현한다. http method는 GET, POST, PUT, DELETE가 있습니다.

GET /items는 items이라는 데이터를 읽는 것을 의미하고, DELETE /items는 items라는 데이터를 삭제하는 것을 의미합니다. 즉, uri가 동일하더라도 어떤 http method를 사용하는지에 따라서 다른 동작을 할 수 있습니다.

자원 = URI

목적으로 하는 자원은 uri를 통해 표현합니다.

아이템을 원하면 /items, 유저 정보를 원하면 /users처럼 표현하여 원하는 데이터를 uri로 표현합니다. 자원을 명사로 표현할 수 있으면 명사만 사용하는 것이 권장되고 있지만, 관계를 명확하게 하기 위한 예외가 존재합니다.

컬렉션을 참조할 때는 복수명사를 사용하여 직관적이게 표현하는 것이 좋습니다. /items는 items collection의 경로이고, /items/3은 id가 3인 item의 경로인 것처럼 표현할 수 있습니다.

참조

https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design