[스프링 입문] API

1. API

API는 정의 및 프로토콜 집합을 사용하여 두 소프트웨어 구성 요소가 서로 통신할 수 있게 하는 매커니즘이다. API를 사용하면 구현 방식을 알지 못하는 제품 또는 서비스와도 통신할 수 있으며 애플리케이션 개발을 간소화하여 시간과 비용을 절약할 수 있다. 

 

최근 서버는 브라우저나 모바일에서 필요한 순수한 데이터만을 전달하는 API 서버의 형태로 변화하고 있다. 대부분 JSON형식으로 데이터를 전송한다.

 

API와 REST에 관한 게시글은 추후에 자세히 작성할 예정.

 

 

@ResponseBody 문자 반환

      

      

      

    
    

      <java />
    
@Controller
public class HelloController {
     @GetMapping("hello-string")
     @ResponseBody
     public String helloString(@RequestParam("name") String name) {
     	return "hello " + name;
     }
}

@ResponseBody 를 사용하면 뷰 리졸버( viewResolver )를 사용하지 않는다. 대신에 HTTP의 BODY에 문자 내용을 직접 반환한다.

 

 

@ResponseBody 객체 반환

      

      

      

    
    

      <java />
    
@Controller
public class HelloController {
     @GetMapping("hello-api")
     @ResponseBody
     public Hello helloApi(@RequestParam("name") String name) {
         Hello hello = new Hello();
         hello.setName(name);
         return hello;
     }
     static class Hello {
         private String name;
         public String getName() {
        	return name;
         }
         public void setName(String name) {
            this.name = name;
         }
     }
}

 

@ResponseBody 를 사용하고, 객체를 반환하면 객체가 JSON으로 변환된다.

 

@ResponseBody 사용 원리

@ResponseBody 를 사용

• HTTP의 BODY에 문자 내용을 직접 반환
• viewResolver 대신에 HttpMessageConverter 가 동작
• 기본 문자처리: StringHttpMessageConverter
• 기본 객체처리: MappingJackson2HttpMessageConverter
• byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

참고: 클라이언트의 HTTP Accept 해더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해서 HttpMessageConverter 가 선택된다