REST API란?
REST API란 REST 아키텍처의 제약 조건을 준수하는 애플리케이션 프로그래밍 인터페이스를 뜻합니다.
REST는 Representational State Transfer의 줄임말입니다.
REST의 구성
REST API는 다음의 구성으로 이루어져 있습니다.
- 자원(Resource) - URI
- 행위(Verb) - HTTP METHOD
- 표현(Representations)
REST의 특징
1) Uniform(유니폼 인터페이스)
Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말합니다.
2) Stateless (무상태성)
REST는 무상태성 성격을 갖습니다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않습니다.
세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 됩니다.
때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해집니다.
단순히 통로라고 보시면 편합니다.
3) Self-descriptiveness (자체 표현 구조)
REST의 또 다른 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현구조로 되어있다는 것입니다.
뒤에 예제가 있겠지만 간단히 보자면
정보를 가져온다 모든유저의/사진
정보를 추가한다 특정유저의/전화번호
정보를 삭제한다 특정유저의/생년월일
이런식으로 되어있습니다.
4) Client -Server 구조
REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션,로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 됩니다.
REST API 디자인 가이드
REST API 설계 시 가장 중요한 항목은 다음 2가지로 요약할 수 있습니다.
첫 번째, URI는 정보의 자원을 표현해야한다.
두 번째, 자원에 대한 행위는 HTTP Method(GET,POST,PUT,DELETE)로 표현한다.
여기서 CRUD원칙을 엿볼수있는데
CRUD원칙은 정보를 가공하는데 사용되는 원칙으로
C create ---> POST
R read ---> GET
U update ---> PUT
D delete --->DELETE
로 볼수있습니다.
REST API 중심규칙
1) URI는 정보의 자원을 표현해야 한다. (리소스명은 동사보다는 명사를 사용)
GET /members/delete/1위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다. URI는 자원을 표현하는데 중점을 두어야 하는데 행위에 대한 표현이 들어가서는 안됩니다.
가져온다 사람들중/삭제한다(x)/첫번째 사람을 (x)
삭제한다 사람들중/첫번째를 (o)
2) 자원에 대한 행위를 HTTP Method(GET,POST,PUT,DELETE 등)로 표현
위의 잘못 된 URI를 HTTP Method를 통해 수정해보면
DELETE /members/1으로 수정할 수 있겠습니다.
회원정보를 가져올 때는 GET, 회원 추가 시의 행위를 표현하고자 할 때는 POST METHOD를 사용하여야합니다.
회원 정보를 가져오는 URI
GET /members/show/1 (x)
GET /members/1 (o)회원을 추가할 때
GET /members/insert/2 (x)
POST/members/2 (o)~~한다 라는것은 맨앞에 붙습니다(GET,POST,PUT,DELETE)중 하나로
HTTP METHOD의 알맞은 역할
POST, GET, PUT, DELETE이 4가지의 Method를 가지고 CRUD를 할 수 있습니다.
- POST POST를 통해 해당 URI를 요청하면 리소스를 생성합니다.
- GET GET을 통해 해당 리소스를 조회합니다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.
- PUT PUT을 통해 해당 리소스를 수정합니다.
- DELETE DELETE를 통해 리소스를 삭제합니다.
URI 설계 시 주의할점
1) 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
http://gunhee.example.com/houses/apartments
http://gunhee.example.com/animals/mammals/whales2) URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고 역으로 리소스가 다르면 URI도 달라져야합니다. REST API는 분명한 URI를 만들어 통신을 해야하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않습니다.
http://gunhee.example.com/houses/apartments (o)
http://gunhee.example.com/animals/mammals/whales/ (x)안드로이드 코틀린 레트로핏을 보게되면 baseURI과 나머지 URI로 구분되며
baseURI는 공통이되는
http://gunhee/example.com/ 이되고
나머지 뒤에붙는것들이 해당 명령에 따른 URI입니다.
원래대로라면 레트로핏코드도 올리고 깃헙도 잔디심고 하면서 같이하려고 했지만 공공api (항공)이 말을 듣지않고
postman으로 분석을 해봐도 시간초과오류만 뜰뿐이지 반응을 하지않아 다른것으로 다시신청을 하려합니다..ㅠㅠ
조만간 Retrofit블로그 글을 올리도록하겠습니다.