[API 작성법] GET API 만드는 법 핵심 정리

GET API란

서버에서 URL을 통해 값을 가져올 때 사용하는 API이다.

 

첫 번째. @RequestMapping으로 구현

@RequestMapping 어노테이션을 별다른 설정 없이 선언하게 되면 HTTP의 모든 요청을 다 받게 되므로

RequestMethod.GET으로 설정하여 요청 형식을 GET으로만 설정한다

언제 사용할까?

스프링 4.3 버전 이후로는 새로 나온 다음의 어노테이션을 사용한다.

특별히 @RequestMapping을 활용해야 하는 내용이 아니라면 잘 사용하지 않는다.

@RequestMapping(value="/hello", method= RequestMethod.GET)
    public String getHello(){
        return "!Hello World!";
    }

---

두 번째. @ GetMapping으로 구현

스프링 4.3 버전 이후부터만 사용 가능

언제 사용할까?

별도의 매개변수가 없이 url로 값을 보내는 GET API를 구현하는 경우

ex) 맵핑된 해당 링크로 접근하면 값이나 view 이름을 반환해줄 때 등

 @GetMapping(value="/name")
    public String getName(){
        return "Flature";
    }

여기까지는 실무에서 잘 쓰이지 않는 방식

---

세 번째. @PathVariable으로 구현

실무에서는 매개변수를 받지 않는 메서드

 

---

네 번째. @RequestMapping으로 구현

@RequestMapping 어노테이션을 별다른 설정 없이 선언하게 되면 HTTP의 모든 요청을 다 받게 되므로

RequestMethod.GET으로 설정하여 요청 형식을 GET으로만 설정한다

---

 

부족한 설명은 추후 추가 예정

 

참고 자료

[위키북스] 스프링 부트 핵심가이드