[스프링부트] 어노테이션을 사용한 api 작성 방법

GET

// 매개변수 없는 GET 메서드
@GetMapping("/members")
public String list() {
    return "members/memberList";
}
    
// 매개변수 있는 GET 메서드
@GetMapping("/members/{variable}")
public String list(@PathVariable String variable) {
    return variable;
}

// 매개변수 있는 GET 메서드
@GetMapping("/members")
public String list(@RequestParam String variable) {
    return variable;
}

 

@GetMapping: HTTP GET 요청을 해당 메소드에 매핑하는 역할

@PathVariable: URL 경로에서 변수 값을 추출

@RequestParam: HTTP 요청의 쿼리 문자열에서 매개변수 값을 추출

 

POST 

@PostMapping("/members")
public String postMember(@RequestBody MemberDto memberDto) {
	return memberDto.toString();
}

 

@PostMapping: HTTP POST 요청을 해당 메소드에 매핑

@RequestBody: HTTP 요청의 본문(body)에 있는 데이터를 메소드의 매개변수로 바인딩

 

PUT 

 

@PutMapping: HTTP POST 요청을 해당 메소드에 매핑

@RequestBody: HTTP 요청의 본문(body)에 있는 데이터를 메소드의 매개변수로 바인딩

 

 

DELETE

@DeleteMapping: HTTP DELETE 요청을 해당 메소드에 매핑

@RequestParam: HTTP 요청의 쿼리 문자열에서 매개변수 값을 추출

 

REST API 문서화 (Swagger)

https://velog.io/@nefertiri/Spring-Swagger-%EB%A5%BC-%EC%82%AC%EC%9A%A9%ED%95%98%EC%97%AC-API-%EB%AA%85%EC%84%B8%EC%84%9C-%EC%9E%91%EC%84%B1-%EC%9E%90%EB%8F%99%ED%99%94%ED%95%98%EA%B8%B0