기본 콘텐츠로 건너뛰기

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]

댓글

이 블로그의 인기 게시물

웹 개발하면서 보안을 유지하기 위한 기본지식

몇개월전에 만들었던 웹기반 (HTML5, CSS3, Flash Player(VideoJS)) VOD플레이어에서 보안이슈가 발생했다. 웹또한 서버를통해 통신을하지만 사용자의 PC에서 실행되는만큼 클라이언트의 개념이 있으며 Javascript 야말로 클라이언트에서 작업하게 되는 영역이라는 점에서 보안상에 이슈 발생.  이유인즉슨  무료로 제공되고 있는것과 유료로 제공되고있는 서비스에 대하여  javascript 단에서 서비스 허용여부를 결정하게될경우  해킹을 통해 이부분을 우회하여 서비스이용이 가능했다는점.. 모든 인증이나, 중요데이터는 java 로 코딩해서 서버단에서 결단이 나도록 했어야했는데 이건 너무 기본적이면서도 아쉬운 실수를 저지르고 말았다..  하하..  많은 분들이 이런 부분을 간과할수도있을듯하여 작성해봅니다.  요즘 보안이슈가 많을탠데 모두들 보안 화이팅 ! 

Android 스마트폰 기본 웹브라우저(Chrome:크롬) 호출하는 스키마(URL Scheme)

신용카드결제 페이지 주소를 카톡으로 던졌을때 카톡 내부에서 결제가 이루어지다보니 결제완료까지 정상적으로 처리되지 않는 경우가 발생한다더라 그래서 생각해본게.. 1) 카카오통 채팅방  2) 링크 전송  3) 링크를 클릭하면 스마트폰애 내장된 웹브라우저를 실행하는 URL스키마 실행  4) 실행된 웹브라우저에서 결제페이지로 이동 이 절차를 거치면 카톡 외부로 나와서 독립적인 웹브라우저상에서 결제를 진행하기때문에 정상처리가 가능할것이라고 판단 찾다 찾다가.. 알아낸것이 안드로이드 (가능) - 롤리팝부터 크롬 브라우저가 기본앱이다 - 크롬을 호출방법 intent://www.naver.com#Intent;scheme=http;package=com.android.chrome;end  아이폰 (조건부 가능) - 사파리를 호출하는 앱스키마가 없으며, 사파리를 통해서 검색어를 입력한 검색기능만 가능 - 크롬브라우저 앱이 설치되어있을경우 아래와같이 호출 가능 googlechrome:////www.naver.com <사용법> < html > < body > < script >      var currentOS = "else" ;      var mobile = ( /iphone | ipad | ipod | android/ i .test(navigator.userAgent.toLowerCase()));      if (mobile) {          var userAgent = navigator.userAgent.toLowerCase();          if (userAgent.search( "android" ) > - 1 )             currentOS = "android" ;          else if

flutter showDatePicker locale 설정을 통해 한국어로 표현되게 하는방법

제목 그대로.. showDatePicker 를 사용하면 아래와같은 형태로 사용할수가 있는데 Future<Null> _selectDate(BuildContext context) async { final DateTime picked = await showDatePicker( context: context , initialDate: selectedDate , firstDate: DateTime ( 2015 , 8 ) , lastDate: DateTime ( 2101 ) , initialDatePickerMode: DatePickerMode. year , //locale : const Locale('kr') ) ; if (picked != null && picked != selectedDate) setState(() { selectedDate = picked ; debugPrint( "_selectDate" ) ; debugPrint(selectedDate.toString()) ; }) ; } 위 소스처럼 locale을 직접 할당하면 datePicker 로딩부터 실패한다 그래서 해결방법을 찾아본 결과 아래와같이 MyApp에서 locale설정을 해주면 이곳에 설정한 locale옵션을 따라서 datepicker의 언어설정이 바뀌게된다 class MyApp extends StatelessWidget { @override Widget build (BuildContext context) { return MaterialApp ( title: 'Flutter Demo