GET API

08 Oct 2021 - 1 minute read

GetMapping과 RequestMapping을 통해 주소 할당하기

---

package com.example.hello.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api/get")
public class GetApiController {

    @GetMapping(path = "/hello")    
    // http://localhost:9090/api/get/hello

    public String hello(){

        return "HELLO";
    }

    @RequestMapping(path = "/hi", method = RequestMethod.GET)    
    // http://localhost:9090/api/get/hi

    // @RequestMapping("/hi")
    // 그냥 위처럼만 적으면 get / post / put / delete 모든 메서드 다 매핑됨
    public String hi(){

        return "HI";
    }
}

Path Variable

---

// http://localhost:9090/api/get/path-variable/{name}
// http://localhost:9090/api/get/path-variable/java
// http://localhost:9090/api/get/path-variable/spring
// {} 안에 계속 변하는 값

    @GetMapping("/path-variable/{name}")
    public String pathVariable(@PathVariable String name){
        System.out.println("PathVariable : " + name);
        return name;
    }



// 주소에 name이라고 해 놨는데 변수 이름을 다른걸 해야한다면? (주소 이름과 변수 이름을 일치시킬 수 없을 때)

   @GetMapping("/path-variable/{name}")
   public String pathVariable(@PathVariable(name = "name") String pathName){
       System.out.println("PathVariable : " + pathName);
       return pathName;
   }

Query Parameter

---

• ex) 구글에 springboot 검색했을 때
  
  https://www.google.com/search
  ?q=springboot
  &oq=springboot
  &aqs=chrome..69i57j0i10i131i433i512j0i512l2j0i10i512j69i60l3.1438j0j7
  &sourceid=chrome
  &ie=UTF-8
  
  

  • and 와 = 로 연결된 걸 볼 수 있다! -> key, value

  • ?key=value1&key2=value2

    // http://localhost:9090/api/get/query-param?user=jinsol&email=ejins0193@gmail.com
  
        @GetMapping(path = "query-param")
        public String queryParam(@RequestParam Map<String, String> queryParam){
  
            StringBuilder sb = new StringBuilder();
  
            queryParam.entrySet().forEach(entry -> {
                System.out.println(entry.getKey());
                System.out.println(entry.getValue());
  
                sb.append("\n" + entry.getKey() + "=" + entry.getValue());
            });
  
            return sb.toString();
        }
  

---

• QueryParameter에 들어갈 변수를 명확하게 지정하기

    // http://localhost:9090/api/get/query-param02?name=jinsol&email=ejins0193@gmail.com
        @GetMapping("query-param02")
        public String queryParam02(
                @RequestParam String name,
                @RequestParam String email
        ){
            System.out.println(name);
            System.out.println(email);
  
            return name + ", " + email;
        }
  

  • 새로운 변수가 생길 때마다 @RequestParam String/int … 해야하는 번거로움 > DTO 형태로 매핑

---

• DTO 형태로 매핑

• 객체를 만들어서 쿼리파라미터가 바로 매핑이 되게 하는 방법

• 가장 많이 사용!

• ex)

  • DTO 폴더 생성 > UserRequest.java

      package com.example.hello.dto;
    
      public class UserRequest {
    
          private String name;
          private String email;
    
          public String getName() {
              return name;
          }
    
          public void setName(String name) {
              this.name = name;
          }
    
          public String getEmail() {
              return email;
          }
    
          public void setEmail(String email) {
              this.email = email;
          }
    
          @Override
          public String toString() {
              return "UserRequest{" +
                      "name='" + name + '\'' +
                      ", email='" + email + '\'' +
                      '}';
          }
      }
    

  • GetApiController.java

    @GetMapping("query-param03")
    
        public String queryParam03(UserRequest userRequest){
    
            System.out.println(userRequest.getName());
            System.out.println(userRequest.getEmail());
    
            return userRequest.toString();
        }