Restful api 규칙

Restful api 설계시 가장 중요한 항목은 다음 2가지로 나눌 수 있습니다.

 

1-1 REST API 중심 규칙

1. URI는 정보의 자원을 표현해야 한다.

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

 

1) URI는 정보의 자원을 표현해야 한다.

    GET /members/delete/1

다음의 행위는 REST를 제대로 적용하지 않은 URI입니다. URI는 자원을 표현하는데 중점을 두어야 합니다. Delete와 같은 행위에 대한 표현이 들어가서는 안된다.

 

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

위의 경우를 수정하면

    DELETE /members/1

와 같은 형태로 수정이 가능하다.

 

실제로 각 Method 별로 행위를 달리하고 행위가 규정되어 있다.

회원 정보를 예를 들어서 각 메소드를 설명하면

1. GET Method : 회원 정보를 가져올때 사용한다.

GET /members/1          (o)

/get{id}의 형태가 아닌 {id}의 형태를 사용하면 자원의 표출에만 집중한다.

Method별로 알맞은 역할들을 정의 해보면

METHOD역할

POST	POST를 통해 해당 URI를 요청하면 리소스를 생성합니다.
GET	GET를 통해 해당 리소스를 조회합니다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.
PUT	PUT를 통해 해당 리소스를 수정합니다.
DELETE	DELETE를 통해 리소스를 삭제합니다.

다음과 같이 URI는 자원을 표현하는데에 집중하고 행위에 대한 정의는 HTTP Method를 통해 하는것이 Rest한 Api를 설계하는 중심 규칙입니다.

 

1-2. URI 설계 시 주의할 점

1. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용합니다.