공부

리소스를 추가하기 위해 사용되는 API

@PostMapping : POST API를 제작하기 위해 사용되는 어노테이션 @RequestMapping + POST method의 조합이다.

일반적으로 추가 하고자 하는 Resouce를 http body에 추가하여 서버에 요청한다. 그렇기 때문에 @RequestBody를 이용하여 body에 담겨있는 값을 받아야 한다.

// http://localhost:8080/api/test/vi/post-api/member
// 해당 URL로 member 데이터를 넘겨주면 해당 데이터의 키값과 value값을 return 하는 예제
@PostMapping(value="/member")
public String postMember(@RequestBody Map<String, Object> postData) {
	StringBuilder sb = new StringBuilder();
    
    postData.entrySet().forEach(map -> {
    	sb.append(map.getKey() + ":" + map.getValue() + "\n");
    });
    
    return sb.toString();
}





// DTO를 사용하는 방식
// key와 value가 정해져있지만, 받아야할 파라미터가 많을 경우 DTO객체를 사용한다.
// GetMapping 과 다른점은 @RequestBody를 꼭 붙여야 한다는 것이다.
@PostMapping(value-"/member2")
public String postMemberDto(@RequestBody MemberDto memberDto) {
	return memberDto.toString();
}

컨트롤러 (Controller)

모델(Model)과 뷰(View) 사이에서 브릿지 역할을 수행한다. 앱의 사용자로부터 입력에 대한 응답으로 모델 및 뷰를 업데이트 하는 로직을 포함하여 사용자의 요청은 모두 컨트롤러를 통해 진행되어야 한다. 컨트롤러로 들어온 요청은 모델이 어떻게 처리할지 결정하여 모델로 요청을 전달한다.

@RestController

• Spring Framework 4 버전부터 사용가능한 어노테이션
• @Controller에 @ResponseBody가 결합된 어노테이션
• 컨트롤러 클래스 하위 메소드에 @ResponseBody 어노테이션을 붙이지 않아도 문자열과 JSON 등을 전송할 수 있음
• View를 거치지 않고 HTTP ResponseBody에 직접 Return 값을 담아 보내게 된다.

@RquestMapping

MVC의 핸들러 매핑(Handler Mappin)을 위해서 DefaultAnnotationHandlerMapping을 사용한다. DefaultAnnotationHandlerMapping 매핑정보로 @RequestMapping 어노테이션을 활용 클래스와 메소드의 RequestMapping을 통해 URL을 매핑하여 경로를 설정하여 해당 메소드에서 처리한다.

value : url 설정

method : GET, POST, DELETE, PUT, PATCH 등

스프링 4.3버전 부터 메소드를 지정하는 방식보다 간단하게 사용할 수 있는 어노테이션을 사용할 수 있음

• @GetMapping
• @PostMapping
• @DeleteMapping
• @PutMapping
• @PatchMapping

API 란?

Application Programming Interface 의 줄임말

응용 프로그램에서 사용할 수 있도록 다른 응용 프로그램을 제어할 수 있게 만든 인터페이스를 뜻한다. API를 사용하면 내부 구현 로직을 알지 못해도 정의되어 있는 기능을 쉽게 사용할 수 있다.

인터페이스(Interface)란 어떤 장치간 정보를 교환하기 위한 수단이나 방법을 의한다. 대표적인 예로는 마우스, 키보드, 터치패드 등이 있다.

REST 란?

REST는 Representational State Transfer의 줄임말

자원의 이름으로 구분하여 해당 자원의 상태를 교환하는 것을 의미한다. REST는 서버와 클라이언트의 통신 방식 중 하나이다.

HTTP URI(Uniform Resource Identifier)를 통해 자원을 명시하고 HTTP Method를 통해 자원을 교환하는 것이다.

*HTTP Method : Create, Read, Update, Delete

REST 의 특징 

1. Server-Client 구조

  자원이 있는 쪽이 Server, 요청하는 쪽이 Client 

  클라이언트와 서버가 독립적으로 분리되어 있어야 한다.

2. Stateless

  요청 간에 클라이언트 정보가 서버에 저장되지 않아야 한다.

  서버는 각각의 요청을 완전히 별개의 것으로 인식하고 처리해야 한다.

3. Cacheable

  HTTP 프로토콜을 그대로 사용하기 때문에 HTTP의 특징인 캐싱 기능을 적용하였다.

  대량의 요청을 효율적으로 처리하기 위해 캐시를 사용한다.

4. 계층화 (Layered System)

  클라이언트는 서버의 구성과 상관 없이 REST API 서버로 요청.

  서버는 다중 계층으로 구성될 수 있다.(로드밸런싱, 보안 요소, 캐시 등)

5. Code on Demand

  요청을 받으면 서버에서 클라이언트로 코드 또는 스크립트를 전달하여 클라이언트 기능 확장

6. 인터페이스 연관성(Uniform Interface)

  정보가 표준 형식으로 전송되기 위해 구성 요소간 통합 인터페이스를 제공한다.

  HTTP 프로토콜을 따르는 모든 플랫폼에서 사용 가능하게끔 설계

REST 의 장점

 HTTP 표준 프로토콜을 사용하는 모든 플랫폼에서 호환 가능하다.

 서버와 클라이언트의 역할을 명확하게 분리해준다.

 여서 서비스 설계에서 발생하는 문제점을 최소화 해준다.

REST API 란?

 REST 아키텍쳐의 조건을 준수하는 어플리케이션 프로그래밍 인터페이스를 뜻한다. 

최근 많은 API 가 REST API로 제공되고 있다. 일반적으로 REST 아키텍쳐를 구현하는 웹 서비스를 RESTful 하다고 표현한다.

REST API 특징

REST 기반으로 시스템을 분산하여 확장성과 재사용성을 높인다. HTTP 표준을 따르고 있어 여러 프로그래밍 언어로 구현할 수 있다.

REST API 설계 규칙

1. 웹 기반의 REST API를 설계할 경우에는 URI 를 통해 자원을 표현해야 한다.

  ex ) https://thinkground.studio/member/589   

       Resource : member

       Resource id : 589

2. 자원에 대한 조작은 HTTP Method(CRUD)를 통해 표현해야 한다.

  URI 에 행위가 들어가서는 안되고, HEADER를 통해 CRUD를 표현하여 동작을 요청해야 한다.

3. 메세지를 통한 리소스 조작

  HEADER를 통해 content-type을 지정하여 데이터를 전달한다. 대표적 형식으로는 HTML, XML, JSON, TEXT 가 있다.

4. URI에는 소문자를 사용한다.

5. Resource의 이름이나 URI가 길어질 경우 하이픈(-)을 통해 가독성을 높일 수 있다.

6. 언더바(_)는 사용하지 않는다.

7. 파일 확장자를 표현하지 않는다.