REST하다는 것은?
잘쓰지는 않는 SOAP방식
SOAP : SOAP의 풀네임은 “Simple Object Access Protocol” 로, HTTP, HTTPS, SMTP 등을 사용하여 XML 기반의 메시지를 컴퓨터 네트워크 상에서 교환하는 통신 프로토콜 웹서비스 내의 모든 데이터는 XML로 표현된다.
1. 서버에서 사이트에 필요한 형식들을 UDDI에 미리올림 (공문서 양식?)
2. 사용자는 사용할 사이트의 형식을 UDDI로 부터 받음
3. 그 형식대로 서버에 요청
4. 로직을 서버에서 수행후 사용자에게 반환
간단히 정리하면 이런 방식인거같다. 많이 복잡해보이지만 이런특징이 있다고한다.
- XML기반으로 플랫폼에 독립적, 서로 다른 운영체제에서 실행되는 서비스간 통신방법을 제공
- 프록시와 방화벽에 구애받지 않고, HTTP, HTTPS등을 통해 메세지를 교환 확장이 용이
- 에러 처리에 대한 내용이 기본적으로 내장
- XML 형태로 메세지를 보내기때문에 다른 기술들에 비해 상대적으로 처리속도가 느림
REST
- REST : REST(Representational State Transfer)는 월드 와이드 웹과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처의 한 형식이다. REST 원리를 따르는 시스템은 종종 RESTful이란 용어로 지칭된다
REST 특징
- Server-Client(서버-클라이언트 구조)
- 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
- REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
- Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
- 서로 간 의존성이 줄어든다.
- 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
- Stateless(무상태)
- HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
- Client의 context를 Server에 저장하지 않는다.
- 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
- Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
- 각 API 서버는 Client의 요청만을 단순 처리한다.
- 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.
- 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
- Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.
- Cacheable(캐시 처리 가능)
- 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
- 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
- HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
- 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
- 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.
- 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
- Layered System(계층화)
- Client는 REST API Server만 호출한다.
- REST Server는 다중 계층으로 구성될 수 있다.
- API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
- 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
- PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
- Code-On-Demand(optional)
- Server로부터 스크립트를 받아서 Client에서 실행한다.
- 반드시 충족할 필요는 없다.
- Uniform Interface(인터페이스 일관성)
- URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
- 특정 언어나 기술에 종속되지 않는다.
실전REST
이러한 특징을 지키는 api를 만드는것이 RESTful하게 만드는것인데 내가 쉽게 이해하기로는 언어의 변수명명법과 클린코드를 위해 지키는 컨벤션이 있듯이 가장 중요한것은 URL의 주소를 규칙대로 설정하는것이다.
아래의 규칙을 최대한 지키면서 URL을 설정해준다.
다만 많은 회사들도 100%다 지키는건아니니 참고
| CRUD | HTTP verbs | Route |
|---|---|---|
| resource들의 목록을 표시 | GET | /resource |
| resource 하나의 내용을 표시 | GET | /resource/:id |
| resource를 생성 | POST | /resource |
| resource를 수정 | PUT | /resource/:id |
| resource를 삭제 | DELETE | /resource/:id |
- 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
- Ex)
http://restapi.example.com/houses/apartments
- Ex)
- URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
- URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
- REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
- Ex)
http://restapi.example.com/houses/apartments/ (X)
- 하이픈(- )은 URI 가독성을 높이는데 사용
- 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
- 밑줄(_ )은 URI에 사용하지 않는다.
- 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
- URI 경로에는 소문자가 적합하다.
- URI 경로에 대문자 사용은 피하도록 한다.
- RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
- 파일확장자는 URI에 포함하지 않는다.
- REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
- Accept header를 사용한다.
- Ex)
http://restapi.example.com/members/soccer/345/photo.jpg (X) - Ex)
GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
- 리소스 간에는 연관 관계가 있는 경우
- /리소스명/리소스 ID/관계가 있는 다른 리소스명
- Ex)
GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)
예시
1) 셀러의 정보를 조작하는 경우
셀러 리스트 출력
- [GET] /sellers
셀러 계정 생성
- [POST] /sellers
1번 셀러 정보 수정
- [PUT] /sellers/1
1번 셀러 삭제
- [DELETE] /sellers/12) 특정 셀러의 특정 자원을 조작하는 경우
1번 셀러의 비밀번호 변경
- [PUT] /sellers/1/password3) 상품 1차, 2차 카테고리 표출
1차 카테고리 표출
- [GET] /products/categories
2차 카테고리 표출
- [GET] /products/categories/1
- [GET] /products/categories/2틀린예시
- Ex1) CRUD 기능을 모두 POST로만 처리하는 API
- Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)
참고사이트
https://velog.io/@devmin/RESTful-API-examples
https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html
https://gruuuuu.github.io/programming/soap/
https://adunhansa.tistory.com/256
("Hello World!");