Spring Boot - 2. REST API를 작성하는 다양한 방법

REST API

먼저 REST란 'Representational State Transfer'의 약자로, 월드 와이드 웹(WWW)과 같은 분산 하이퍼미디어 시스템 아키텍처의 한 형식 입니다. 주고받는 자원(Resource)에 이름을 규정하고 URI에 명시해 HTTP메소드(GET, POST, PUT, DELETE)를 통해 해당 자원의 상태를 주고받는 것을 의미 합니다.

 

REST API는 REST아키텍처를 따르는 시스템/애플리케이션 인터페이스라고 볼 수 있습니다. REST 아키텍처를 구현하는 웹 서비스를 'RESTful하다'라고 표현합니다.

REST의 특징

유니폼 인터페이스

유니폼 인터페이스는 일관된 인터페이스를 의미 합니다. 즉, REST 서버는 HTTP 표준 전송 규약을 따르기 때문에 어떤 프로그래밍 언어로 만들어졌느냐와 상관없이 플랫폼 및 기술에 종속되지 않고 다 호환하여 사용할 수 있다는 것을 의미 합니다.

무상태성(Stateless)

무상태성이란 서버에 상태 정보를 따로 보관하거나 관리하지 않는다는 의미 입니다.

서버는 클라이언트가 보낸 요청에 대해 세션이나 쿠키 정보를 별도 보관하지 않습니다. 그렇기 때문에 한 클라이언트가 여러 요청을 보내든 여러 클라이언트가 하나의 요청을 보내든 개별적으로 처리합니다. 따라서, 비즈니스 로직의 자유도가 높고 설계가 단순합니다.

캐시

REST는 HTTP 표준을 그대로 사용하므로 HTTP의 캐싱 기능을 적용할 수 있습니다.

레이어 시스템

REST 서버는 네트워크 상의 여러 계층으로 구성될 수 있습니다.

그러나 서버의 복잡도와 관계없이 클라이언트는 서버와 연결되는 포인트만 알면 됩니다.

클라이언트-서버 아키텍처

REST 서버는 API를 제공하고 클라이언트는 사용자 정보를 관리하는 구조로 분리해 설계합니다.

이 구성은 서로에 대한 의존성을 낮추는 기능을 합니다.

⭐️REST의 URI 설계 규칙

URI는 특정 리소스를 식별할 수 있는 식별자를 의미합니다.

1. URI의 마지막에는 '/'를 포함하지 않습니다.
2. 언더바 대신 하이픈(-)을 사용
3. 행위(동사)가 아닌 결과(명사)를 포함
4. 소문자로 작성
5. 파일의 확장자는 포함하지 않음

@RequestMapping으로 구현

@RestController
@RequestMapping("api/v1/get-api")
public class GetController {
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String getHello() {
        return "Hello world";
    }
}

매개변수가 없는 GET 메소드 구현

@RestController
@RequestMapping("api/v1/get-api")
public class GetController {
    @GetMapping(value ="/name")
    public String getHello() {
        return "Get : 곰돌이사육사";
    }
}

@PathVariable을 활용한 GET 메서드 구현

@GetMapping(value = "/variable1/{variable}")
public String getVariable1(@PathVariable String variable) {
    return variable;
}

@GetMapping(value = "/variable2/{variable}")
public String getVariable2(@PathVariable("variable") String var) {
    return var;
}

@RequestParam을 활용한 GET 메서드 구현

// http://localhost:8113/api/v1/get-api/request1?name=ddd&email=ddd2024@gmail.com&organization=kh
    @GetMapping(value = "/request1")
    public String getRequestParam(
            @RequestParam String name,
            @RequestParam String email,
            @RequestParam String organization) {
        return name + " " + email + " " + organization;
    }

@RestController와 @GetMapping을 사용한 JSON

package com.springboot.hello.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@RestController
public class TestJsonController {
    @GetMapping("/members")
//    @ResponseBody : @RestController 어노테이션이 있으면 해당 어노테이션을 명시 하지 않아도 된다.
    public List<Map<String, Object>> findMembers() {
        List<Map<String, Object>> members = new ArrayList<>();
        for(int i = 1; i <= 20; i++) {
            Map<String, Object> member = new HashMap<>();
            member.put("id", i);
            member.put("name", i + "번 개발자");
            member.put("age", 10+ i);
            members.add(member);
        }
        return members;
    }
}

@RestController
public class MemberController {
    @GetMapping("/memberVO")
    public MemberVO member() {
        MemberVO vo = new MemberVO();
        vo.setId("ddd2024");
        vo.setPwd("!@#$df0");
        vo.setName("홍길동");
        vo.setEmail("ddd2024@gmail.net");
        return vo;
    }
}
@GetMapping("/memberList")
    public List<MemberVO> listMember() {
        List<MemberVO> list = new ArrayList<>();
        for(int i = 0; i < 10; i ++) {
            MemberVO vo = new MemberVO();
            vo.setId("ddd" + i);
            vo.setPwd("@#$#df" + i);
            vo.setName("홍길동" + i);
            vo.setEmail("ddd" + i + "@gmail.com");
            list.add(vo);
        }
        return list;
    }

@ResponseEntry 사용해서 응답하기

@GetMapping("/membersList2")
public ResponseEntity<List<MemberVO>> listMember2() {
    List<MemberVO> list = new ArrayList<>();
    for (int i = 0; i < 10; i++) {
        MemberVO vo = new MemberVO();
        vo.setId("ddd");
        vo.setPwd("@$%#@df");
        vo.setName("홍길동");
        vo.setEmail("ddd@gmail.com");
        list.add(vo);
    }
    return new ResponseEntity(list, HttpStatus.INTERNAL_SERVER_ERROR);
}

POST API 만들기

@RequestMapping으로 구현하기

@RestController
@RequestMapping("/api/v1/post-api")
public class PostController {
    @RequestMapping(value = "/domain", method = RequestMethod.POST)
    public String postExample() {
        return "Hello Post API";
    }
}

@RequestBody를 활용한 POST 메서드 구현

@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();
}

@ResponseEntity 사용해서 응답

@GetMapping("/GetMemberParam")
public ResponseEntity <List<MemberVO>> memberList(@RequestParam String cmd) {
    if(cmd.equals("MemberList")) {
        MemberDAO dao = new MemberDAO();
        List<MemberVO> list = dao.memberSelect();
        return new ResponseEntity<>(list, HttpStatus.OK);
    } else {
        return new ResponseEntity<>(null, HttpStatus.BAD_REQUEST);
    }
}