페이지 이력

...

클라이언트/서버 구조 : 일관적인 인터페이스로 분리되어야 한다
무상태(Stateless) : 각 요청 간 클라이언트의 컨텍스트가 서버에 저장되어서는 안 된다
캐시 처리 가능(Cacheable) : WWW에서와 같이 클라이언트는 응답을 캐싱할 수 있어야 한다.
- 잘 관리되는 캐싱은 클라이언트-서버 간 상호작용을 부분적으로 또는 완전하게 제거하여 scalability와 performance를 향상시킨다.
계층화(Layered System) : 클라이언트는 보통 대상 서버에 직접 연결되었는지, 또는 중간 서버를 통해 연결되었는지를 알 수 없다. 중간 서버는 로드 밸런싱 기능이나 공유 캐시 기능을 제공함으로써 시스템 규모 확장성을 향상시키는 데 유용하다.
Code on demand (optional) : 자바 애플릿이나 자바스크립트의 제공을 통해 서버가 클라이언트가 실행시킬 수 있는 로직을 전송하여 기능을 확장시킬 수 있다.
인터페이스 일관성 : 아키텍처를 단순화시키고 작은 단위로 분리(decouple)함으로써 클라이언트-서버의 각 파트가 독립적으로 개선될 수 있도록 해준다.

REST

...

인터페이스의 원칙

원칙	세부 설명
자원의 식별	요청 내에 기술된 개별 자원을 식별할 수 있어야 한다. 웹 기반의 REST 시스템에서의 URI의 사용을 예로 들 수 있다. 자원 그 자체는 클라이언트가 받는 문서와는 개념적으로 분리되어 있다. 예를 들어, 서버는 데이터베이스 내부의 자료를 직접 전송하는 대신, 데이터베이스 레코드를 HTML, XML이나 JSON 등의 형식으로 전송한다.
메시지를 통한 리소스의 조작	클라이언트가 어떤 자원을 지칭하는 메시지와 특정 메타데이터만 가지고 있다면 이것으로 서버 상의 해당 자원을 변경·삭제할 수 있는 충분한 정보를 가지고 있는 것이다.
자기서술적 메시지	각 메시지는 자신을 어떻게 처리해야 하는지에 대한 충분한 정보를 포함해야 한다. 예를 들어 MIME type과 같은 인터넷 미디어 타입을 전달한다면, 그 메시지에는 어떤 파서를 이용해야 하는지에 대한 정보도 포함해야 한다. 미디어 타입만 가지고도, 클라이언트는 어떻게 그 내용을 처리해야할 지 알 수 있어야 한다. 메시지를 이해하기 위해 그 내용까지 살펴봐야 한다면, 그 메시지는 자기서술적이 아니다. 예를 들어, 단순히 "application/xml"이라는 미디어 타입은, 실제 내용을 다운로드 받지 않으면 그 메시지만 가지고는 무엇을 해야할지에 대해 충분히 알려주지 못한다.
애플리케이션의 상태에 대한 엔진으로서 하이퍼미디어	만약에 클라이언트가 관련된 리소스에 접근하기를 원한다면, 리턴되는 지시자에서 구별될 수 있어야 한다. 충분한 콘텍스트 속에서의 URI를 제공해주는 하이퍼텍스트 링크의 예를 들 수 있겠다.

...

코드 블럭

language	java
linenumbers	true

@GetMapping("/{id}")
public ResponseEntity<?> getBazz(@PathVariable String id){
    return new ResponseEntity<>(new Bazz(id, "Bazz"+id), HttpStatus.OK);
}
 
@PostMapping
public ResponseEntity<?> newBazz(@RequestParam("name") String name){
    return new ResponseEntity<>(new Bazz("5", name), HttpStatus.OK);
}
 
@PutMapping("/{id}")
public ResponseEntity<?> updateBazz(@PathVariable String id, @RequestParam("name") String name) {
    return new ResponseEntity<>(new Bazz(id, name), HttpStatus.OK);
}
 
@DeleteMapping("/{id}")
public ResponseEntity<?> deleteBazz(@PathVariable String id){
    return new ResponseEntity<>(new Bazz(id), HttpStatus.OK);
}

URI 규칙

규칙	설명
슬래시 구분자(/)는 계층 관계를 나타내는 데 사용한다	http://api.canvas.restapi.org/shapes/polygons/quadrilaterals/squares /를 통해서 리소스간 계층 관계를 표현함
URI 마지막 문자로 슬래시(/)를 포함하지 않는다	http://api.canvas.restapi.org/shapes http://api.canvas.restapi.org/shapes/
하이픈(-)은 URI 가독성을 높이는 데 사용한다	http://api.example.restapi.org/blogs/mark-masse/entries/this-is-my-first-post URI를 쉽게 읽고 해석하기 위해서 긴 URI 경로에 하이픈을 사용해서 가독성을 높일 수 있음 URI에서는 문장 내 공백을 하이픈으로 변경할 수 있음
밑줄(_)은 URI에 사용하지 않는다	편집기 등에서 URI는 클릭이 가능한 Link 형태로 표시하여 _
URI경로에는 소문자가 적합하다
파일 확장자는 URI에 포함시키지 않는다
API에 있어서 서브 도메인은 일관성 있게 사용해야 한다
클라이언트 개발자 포탈 서브 도메인 이름은 일관성 있게 만들어야 한다



http://hungry-developer.blogspot.com/2014/06/rest-api.html

GET Method에서 파라미터 처리

파라미터 종류

URL 형식

Spring Annotation

예시

Request Parameter

/login?index=1&page=2

@RequestParam

코드 블럭

language	java
linenumbers	true

@GetMapping("login")
public ModelAndView login(@RequestParam("index") int index, 
                                   @RequestParam("page") int page) {
  //...    
}

Path Variable

/index/1

@PathVariable

코드 블럭

language	java
linenumbers	true

@PostMapping("index/{idx}")
@ResponseBody
public ModelAndView index(@PathVariable("idx") int index) {
  //...
}

...

페이지 트리

버전 비교

이전 버전 7

새 버전 8

키

REST

인터페이스의 원칙

URI 규칙

GET Method에서 파라미터 처리