반응형
Rest API
여러 블로그에서 정리된 내용을 종합하여 공부한 내용을 정리해봅니다.
Rest?
정의
Rest는 REpresentational State Transfer의 줄임말.
자원을 이름으로 구분하여 자원의 상태를 주고받는것을 의미.
구성
- 자원(Resource) - URI
- 실제 서버에 저장된 데이터
- 이미지, 동영상, DB 등
- 행위(Verb) - Method
- 저장, 삭제, 읽기 등 자원을 다루는 행위
- 표현(Representation of Resource)
- 자원을 부르는 이름
- 게시글 데이터 -> psot로 표현
특징
- Server-Client (서버-클라이언트 구조)
- Client는 자원을 요청히고, Server는 요청을 처리.
- 각자 개발할 부분이 명확해지고, 의존성이 줄어든다.
- Stateless (무상태)
- REST는 HTTP 프로토콜을 이용하므로 REST 역시 Stateless이다.
- REST는 자원에 대한 상태를 따로 저장하지 않는다.
서버로 들어오는 요청만 처리하면 된다. - 서버에 불필요한 자원 처리를 하지 않아도 되므로 구현이 쉬워지고, 자유도가 높아진다.
- Cacheable (캐시 처리 기능)
- REST는 HTTP 프로토콜을 이용하므로 캐싱 기능을 사용할 수 있다.
- 캐시 처리를 통해 응답 속도를 향상 시킬 수 있다.
- Layered System (계층 구조)
- REST Server는 여러 계층으로 구성할 수 있다.
- 자원에 대한 요청을 수행하기 전에 암호화, 사용자 인증 등을 추가해 구조산 유연성을 둘 수 있다.
- Uniform Interface (인터페이스 일관성)
- 자원에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
- 언어나 플랫폼 상관 없이 HTTP 프로토콜을 따르는 모든 곳에서 사용이 가능하다.
- Self-Descriptivness (자체 표현)
- REST API 메세지만 보고도 쉽게 이해 가능한 표현 구조로 작성되어있다.
CRUD
- 자원에 대한 4가지 행위(Verb).
- HTTP Method(GET, POST, PUT, DELETE)로 표현.
- GET - Read(정보 요청), URI가 가진 정보를 검색하기 위해 서버에 요청
- POST - Create(정보 입력), 클라이언트에서 서버로 전달하려는 정보를 전송
- PUT - Update(정보 업데이트), 내용을 갱신하기 위해 사용
- DELETE - Delete(정보 삭제), 내용을 삭제
- Patch - 일부 내용만 수정
- HEAD
Rest API?
정의
- REST의 원리와 특징을 따르는 API.
중심 규칙
- URI는 정보의 자원을 표현해야 한다.
GET /members/delete/1 - 잘못된 예시 GET /members/1 - 자원의 대한 행위는 HTTP Method로 표현해야 한다.
GET /members/1 - 잘못된 예시 DELETE /members/1
설계 기본 규칙
- URI는 동사보다는 명사를, 대문자보다는 소문자를 이용해야 한다.
GET /members/getAllUsers - 잘못된 예시 get /members/users - / 는 계층 관계를 표현한다.
- URI의 마지막에는 / 를 포함하지 않는다.
- _ 보다는 - 을 사용한다.
- URI는 소문자로만 구성된다.
- URI에 파일 확장자는 포함하지 않는다.
- HTTP 응답 상태 코드로 클라이언트는 요청에 대한 피드백을 받아야 한다.
레퍼런스
[네트워크] REST API란? REST, RESTful이란?
[Network] REST란? REST API란? RESTful이란? - Heee's Development Blog
REST란? REST API 와 RESTful API의 차이점
REST API 제대로 알고 사용하기 : NHN Cloud Meetup
반응형