REST API?
REST는 Representational State Transfer라는 용어의 약자로서 2000년도에 로이 필딩의 박사학위 논문에서 최초로 소개
웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다고합니다.
RESPT API란 REST의 원리를 따르는 API를 의미합니다.
REST 구성
쉽게 말해 REST API는 다음의 구성으로 이루어져있습니다.
- 자원(RESOURCE) - URI
- 행위(Verb) - HTTP METHOD
- 표현(Representations)
1) URI는 정보의 자원을 표현해야한다. (리소스명은 동사보다는 명사를 사용)
GET /members/delete/1
위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다.
URI는 자원을 표현하는데 중점을 두어야합니다. delete와 같은 행위에 대한 표현이 들어가서는 안됩니다.
2) 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)으로 표현
위의 잘못된 URI를 HTTP Method를 통해 수정한다면
DELETE /members/1
회원정보를 등록하는 URI
GET /members/insert/2 (x) // GET 메서드는 리소스 생성에 맞지 않음
POST /members/2 (o)
HTTP Method의 알맞은 역할 POST, GET, PUT, DELETE이 4가지의 Method를 가지고 CRUD를 할 수 있습니다.
| Method |
역할 |
| POST |
POST를 통해 해당 URI를 요청하면 리소스를 생성합니다. |
| GET |
GET을 통해 해당 리소스를 조회, 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져옵니다. |
| PUT |
PUT을 통해 해당 리소스를 수정합니다. |
| DELETE |
DELETE를 통해 리소스를 삭제합니다. |
URI 설계 시 유의할 점
1) 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
http://restapi.example.com/houses/apartments
http://restapi.example.com/animals/mammals/whales
2) URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 합니다. REST API는 분명한 URI를 만들어 통신하는 것이 목표이기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시를 사용하지 않습니다.
http://restapi.example.com/houses/apartments/ (X)
http://restapi.example.com/houses/apartments (0)
3) 하이픈(-)은 URI 가독성을 높이는데 사용
URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI 경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있습니다.
4) 밑줄(_)은 URI에 사용하지 않는다.
글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 합니다.
이런 문제를 피하기 위해 밑줄 대신 하이픈(-)을 사용하는 것이 좋습니다. (가독성 측면)
5) URI 경로에는 소문자가 적합하다.
URI 경로에 대문자 사용은 피하도록 해야합니다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문입니다.
RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대문자를 구별하도록 규정하고 있습니다.