REST, REST API, RESTFUL API

[REST (Representational State Transfer)]

    자원을 URI로 표시하고 해당 자원의 상태를 주고 받는 것

    REST하지 못한 API는 ?

        CRUD 기능을 전부 POST METHOD로만 처리하는 API

        URI에 자원과 id외 정보가 들어가는 경우

[REST 구성 요소]

    자원(Resource): URI

    행위(Verb): HTTP METHOD

    표현(Representations)

    즉, Rest는 URI를 통해 자원을 표시하고, 

    HTTP METHO를 이용하여 해당 자원의 행위를 정해주며

    그 결과를 받는 것

[REST 특징]

    Uniform Interface (유니폼 인터페이스)

        HTTP 표준만 따른다면 어떤 언어 혹은 어떤 플랫폼에서 사용하여도 사용이 가능한 인터페이스 스타일

    

    Stateless (상태 정보 유지 안함)

        서버는 각각의 요청을 완전히 다른 것으로 인식하고 처리

        이전 요청이 다음 요청 처리에 연관이 되면 안된다

    Cacheable (캐시 가능)

        웹 표준을 그대로 사용하기 때문에 HTTP가 가진 캐싱 기능 적용이 가능

    Self-descriptiveness (자체 표현 구조)

        Rest API 메시지만 보고도 쉽게 이해할 수 있는 자체 표현 구조

    Client-Server

        Rest 서버는 API 제공

        클라이언트는 사용자 인증에 관련된 일들을 직접 관리

        자원이 있는 쪽을 Server라고 하고 자원을 요청하는 쪽이 Client가 됨

        서로간의 의존성이 줄어들기 때문에 역할이 확실하게 구분되어 개발해야할 내용들이 명확해짐

    Layerd System (계층화)

        클라이언트는 Rest API 서버만 호출

        Rest 서버는 다중 계층으로 구성될수 있음

        로드 밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 둘 수 있음

[REST API]

    Rest 기반의 규칙들을 지켜서 설계된 API를 Rest API 혹은 Restful API라고 함

[REST API 설계 규칙]

    URI는 정보의 자원을 표현

    자원의 이름은 명사로 사용

    URI는 자원을 표현하는데 중점을 둠, 행위에 대한 표현이 들어가면 안됨

    

    GET /users/321

        자원에 대한 행위는 HTTP METHOD로 표현 (GET, POST, PUT DELETE)

        URI에 자원의 행위에 대한 표현이 들어가지 않는 대신 HTTP METHOD를 통해 대신함

        GET /users/321 

        321 ID를 가진 유저 정보를 가져오기

        DELETE /users/321 

        321 ID를 가진 유저 정보를 삭제하기

        POST /users 

        유저를 생성하기

    슬래시 (/)는 계층 관계를 나타내는데 사용

        http://restapi.test.com/users/rooms

        http://restapi.test.com/users/board

    

    URI 마지막은 슬래시(/)를 사용하면 안된다.

        http://restapi.test.com/users/rooms/ [X]

        http://restapi.test.com/users/rooms  [O]

    하이픈 (-)은 URI의 가독성을 높이는데 사용

    언더바(_) 혹은 밑줄은 URI에 사용하지 않음

    URI는 경로에는 소문자가 적합

    대소문자에 따라 각자 다른 리소스로 인식하기 때문

    파일 확장자는 URI에 포함하지 않는다

        Accept header를 사용

    리소스 간의 관계를 표현하는 방법

        GET : /users/{userid}/devices

[RESTFUL API]

    REST를 REST답게 쓰기 위한 방법이지만 누군가가 공식적으로 발표한 것이 아니고

    그저 개발자들이 비공식적으로 의견을 제시한 것이라 명확한 정의는 없다고 함

    하지만 RESTFUL의 목적은 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것

    CRUD                 HTTP METHOD    URI

    user들을 표시       GET             /users

    user 하나만 표시   GET             /users/:id

    user를 생성      POST             /users

    user를 수정      PUT             /users/:id

    user를 삭제      DELETE             /users/:id

    

    Restful 하지 못한 경우

        CRUD 기능을 전부 POST METHOD로만 처리하는 API

        URI에 자원과 id외 정보가 들어가는 경우

    

        PUT /users/update-nickname [X]

        PUT /users/:id/nickname [O]