01. REST이전

Image Added

• 장점
  • API만 보아도 어떤 API인지 알 수 있다.
• 단점
  • 개발자마다 API설계가 다르다.
  • CRUD를 만들기 위해 API를 여러개 만들어야 한다.

02. REST의 개념

...

• REST : Representational State Transfer
  • 자원(resource)의 표현(representation) 에 의한 상태(State
  ) 전달

Image Removed
REST란

• • )

...

• • 전달
    • 자원

...

• • • :

...

• • • 문서, 그림, 데이터,

...

• • • 소프트웨어 자체 등

...

• • • 표현:

...

• • • 그자원을 표한하기 위한 이름

...

• • • 예) 영화=movies
    • 상태: 자원의 상태를 전달
      • PUT: 자원이 업데이트된 상태
      • POST: 자원이 새로 추가된 상태
      • GET: 자원을 읽은 상태
      • DELETE: 자원이 삭제된 상태

Image Added

• REST의 특징
  • Server-Client구조
  • Stateless(무상태)
  • Cacheable(캐시 처리 가능)
  • Layered System(계층화)
    • Rest server를 다중 계층으로 구성
      • 보안, LB, 암호화, 인증등의 계층을 추가.
  • Code-on-demand(optional)
    
    • Server로 부터 스크립트를 받아서 Client에서 실행한다

...

• • • .
  • Uniform Interface(인터페이스 일관성)
    • URI로 지정한

...

• • • 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.

...

03. HTTP의 역사

• HTTP/0.9

  • 1991년 월드와이드 웹 공식출발과 함께 시작

  • method : GET

  • Header가 없음

  • GET /mypage.html

• HTTP/1.0

  • 1996년 11월  RFC 1945에 공개

  • HTTP Header및 Content-Type추가로 HTML이외의 문서도 전송가능

  • method: GET, POST
  • GET /mypage.html HTTP/1.0
• HTTP/1.1
  • 1997년 1월 RFC 2068에서 처음 공개
  • HTTP의 첮번째 표준
  • method: GET, POST, OPTIONS, PUT, DELETE, TRACE
• HTTP/2
  • 2015년 5월 공식 표준화

REST API

• REST기반으로 서비스 API를 구현한것
• 장점
  • API디자인에서 발생할 수 있는 문제를 최소화 한다.
  • 서버와 클라이언트 역할을 명확하게 분리한다.
  • API가 의도하는 바를 쉽게 파악할 수 있다.
  • HTTP표준 프로토콜에 따르는 모든 플랫폼에서 사용 가능하다.
• 단점
  • 표준이 존재하지 않는다.
  • 사용할 수 있는 메소드가 4가지 밖에 없다.

Image Added

도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
스토어 : 클라이언트에서 관리하는 리소스 저장소
URI는 정보의 자원을 표현해야 한다.
resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
resource의 스토어 이름으로는 복수 명사를 사용해야 한다.
Ex) GET /Member/1 -> GET /members/1
자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
URI에 HTTP Method가 들어가면 안된다.
Ex) GET /members/delete/1 -> DELETE /members/1
URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
Ex) GET /members/show/1 -> GET /members/1
Ex) GET /members/insert/2 -> POST /members/2
경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
Ex) student를 생성하는 route: POST /students
Ex) id=12인 student를 삭제하는 route: DELETE /students/12
REST API 설계 규칙
슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
Ex) http://restapi.example.com/houses/apartments
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’의 관계를 표현할 때)
REST API 설계 예시

참고 응답상태코드

1xx : 전송 프로토콜 수준의 정보 교환
2xx : 클라어인트 요청이 성공적으로 수행됨
3xx : 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
4xx : 클라이언트의 잘못된 요청
5xx : 서버쪽 오류로 인한 상태코드
RESTful의 개념

Image Removed

...