RestAPI(Representational State Transfer API)

💁‍♀️ RestAPI란,
클라이언트와 서버 간에 데이터를 주고받기 위한 인터페이스로, 웹 어플리케이션에서 서버 데이터를 요청하고 받을 수 있도록 돕는 기술

• REST API는 데이터 형태를 주로 JSON 혹은 XML 형식으로 반환
• 클라이언트는 HTTP 요청(GET, POST, PUT, DELETE 등)을 보내는 것으로 서버에서 제공하는 기능 이용 가능

---

👀 타입별 응답 (Response)

👉 Message

public class Message {

	private int httpStatusCode;
	private String message;
    
    /* 기본 셋팅 */
}

👉 ResponseRestController

@RestController

/* @Controller + @ResponseBody의 의미
 * 클래스 레벨에 작성하며 해당 클래스 내의 모든 핸들러 메소드에 @ResponseBody 어노테이션을 묵시적으로 적용한다는 의미 (리턴값이 곧 응답값) */
@RestController
@RequestMapping("/response")
public class ResponseRestController {

[1] 문자열 응답

	/* 1. 문자열 응답 */
	@GetMapping("/hello")
	public String helloworld() {
		
		return "Hello World🥳";
	}

[2] 기본 자료형 응답

	/* 2. 기본 자료형 응답 */
	@GetMapping("/random")
	public int getRandomNumber() {
		
		return (int) (Math.random() * 10) + 1;
	}

[3] Object 응답

	/* 3. Object 응답 */
	@GetMapping("/message")
	public Message getMessage() {
		
		return new Message(200, "메세지 응답 성공!🤩");
	}

[4] List 응답

	/* 4. List 응답 */
	@GetMapping("/list")
	public List<String> getList() {
		
		return List.of(new String[] {"햄서터🐹", "호랭이🐯", "산독기🐰"});
	}

[5] Map 응답

	/* 5. Map 응답 */
	@GetMapping("/map")
	public Map<Integer, String> getMap() {
		
		List<Message> messageList = new ArrayList<>();
		messageList.add(new Message(200, "응답 성공!🐥"));
		messageList.add(new Message(404, "페이지를 찾지 못 했어요💩"));
		messageList.add(new Message(500, "님의 잘못!🐷"));
		
		return messageList.stream().collect(Collectors.toMap(Message::getHttpStatusCode, Message::getMessage));
	}

[6] ImageFile 응답

	/* 6. ImageFile 응답 
	 * produces 설정은 response header의 content-type 설정
	 * 설정을 따로 하지 않으면 text/html로 응답하기 때문에 이미지가 텍스트 형태로 전송 됨*/
	@GetMapping(value="/image", produces=MediaType.IMAGE_PNG_VALUE)
	public byte[] getImage() throws IOException {
		
		return getClass().getResourceAsStream("/com/greedy/api/section01/response/sample.png").readAllBytes();
	}

[7] ResponseEntity를 이용한 응답

	/* 7. ResponseEntity를 이용한 응답 (대부분 이 방식을 사용) */
	@GetMapping("/entity")
	public ResponseEntity<Message> getEntity() {
		
		return ResponseEntity.ok(new Message(123, "Baby Cheese"));
	}
	
}

---

👀 Response Entity

ResponseEntity

💁‍♀️ Response Entity란,
결과 데이터와 HTTP 상태 코드, 응답 헤더를 직접 제어할 수 있는 클래스

👉 UserDTO

public class UserDTO {
	
	private int no;
	private String id;
	private String pwd;
	private String name;
	private Date enrollDate;
    
    /* 기본 셋팅 */
    
}

👉 ResponseMessage

public class  ResponseMessage {

	private int httpStatus;
	private String message;
	private Map<String, Object> results;
    
    /* 기본 셋팅 */
    
}

👉 ResponseEntityTestController

@RestController
@RequestMapping("/entity")
public class ResponseEntityTestController {
	
	private List<UserDTO> users;
	
	public ResponseEntityTestController() {
		users = new ArrayList<>();
		users.add(new UserDTO(1, "user01", "pass01", "허치치", new Date()));
		users.add(new UserDTO(2, "user02", "pass02", "허꼬순", new Date()));
		users.add(new UserDTO(3, "user03", "pass03", "허부왁", new Date()));
	}

[1] 모든 User 조회

@GetMapping HttpHeaders setContentType() MediaType Charset.forName()

	@GetMapping("/users")
	public ResponseEntity<ResponseMessage> findAllUsers() {
		
		HttpHeaders headers = new HttpHeaders();
		headers.setContentType(new MediaType("application", "json", Charset.forName("UTF-8")));
		
		Map<String, Object> responseMap = new HashMap<>();
		responseMap.put("users", users);
		
		ResponseMessage responseMessage = new ResponseMessage(200, "조회 성공!🐶", responseMap);
		
		return new ResponseEntity<>(responseMessage, headers, HttpStatus.OK); // new ResponseEntity<>(메세지, 컨텐츠타입, 상태코드)
		
		// users라는 key값에 add한 user들을 Map에 넣고, responseMessage에 그 Map을 함께 담아 보냄 
		// 결국 응답 값은 responseMessage가 JSON 형태로 옴 !!
	}

[2] User 조회

@GetMapping stream() filter() toList() ok() headers() body()

	@GetMapping("/users/{userNo}")
	public ResponseEntity<ResponseMessage> findUserByNo(@PathVariable int userNo) {
		
		HttpHeaders headers = new HttpHeaders();
		headers.setContentType(new MediaType("application", "json", Charset.forName("UTF-8")));
		
		UserDTO foundUser = users.stream().filter(user -> user.getNo() == userNo).toList().get(0); // no가 일치하는 user를 찾고 List로 반환
	
		Map<String, Object> responseMap = new HashMap<>();
		responseMap.put("user", foundUser);
		
		/* 빌더 패턴으로도 작성 가능 (방식의 차이일뿐, 결과는 위와 같음) */
		return ResponseEntity
				.ok()
				.headers(headers)
				.body(new ResponseMessage(200, "조회 성공!🐶", responseMap));
	}

[3] User 등록

@PostMapping @RequestBody created(URI.create()) build()

	// body 쪽에 응답할 것이 따로 없을 떄 ResponseEntity<?>
	@PostMapping("/users")
	public ResponseEntity<?> registUser(@RequestBody UserDTO newUser) { 
		// @ModelAttribute : url encoded 방식으로 데이터가 넘어옴을 의미(기본값, 생략가능) => key=value&key=value
		// @RequestBody : JSON 방식의 문자열로 넘어옴을 의미(JSON 방식으로 받기 위해 명시 필요) => "key" : value, "key" : value
		
		int lastUserNo = users.get(users.size()- 1).getNo();
		newUser.setNo(lastUserNo + 1);
		newUser.setEnrollDate(new Date());
		
		users.add(newUser);
		
		/* 조회 시에는 200번 코드를 응답하지만 삽입 시에는 201번 코드를 응답
		 * 201 : 요청이 성공적으로 처리 되었으며, 자원이 생성되었음을 나타내는 성공 상태 응답 코드
		 * 해당 자원에 대한 요청 url을 location으로 설정하여 응답 */
		return ResponseEntity
				.created(URI.create("/entity/users/" + users.get(users.size() - 1).getNo())) 
				.build();
		// 위에서 newUser가 추가 되었으므로 총 users의 사이즈에서 -1을 한 것의 no가 추가해야할 user
	}

[4] User 수정

@PutMapping

	@PutMapping("/users/{userNo}")
	public ResponseEntity<?> modifyUser(@PathVariable int userNo, @RequestBody UserDTO modifyInfo) {
		
		UserDTO foundUser = users.stream().filter(user -> user.getNo() == userNo).toList().get(0);
		foundUser.setId(modifyInfo.getId());
		foundUser.setPwd(modifyInfo.getPwd());
		foundUser.setName(modifyInfo.getName());
		
		/* 수정 요청으로 자원이 변경 된다면 201번 코드로 응답
		 * 만약 자원 수정 요청의 결과가 기존의 자원 내용과 동일하여 변경된 내용이 없을 때는 204로 응답할 수도 있음
		 * 204 : 요청이 성공했으나 클라이언트가 현재 페이지에서 벗어나지 않아도 된다는 것을 나타내는 상태 코드 */
		return ResponseEntity
				.created(URI.create("/entity/users/" + userNo))
				.build();
		
	}

[5] User 삭제

@DeleteMapping noContent()

	@DeleteMapping("/users/{userNo}")
	public ResponseEntity<?> removeUser(@PathVariable int userNo) {
		
		UserDTO foundUser = users.stream().filter(user -> user.getNo() == userNo).toList().get(0);
		users.remove(foundUser);
		
		/* 삭제 요청을 하여 더이상 참조할 수 없을 경우 204번으로 응답하는 것이 규칙 */
		return ResponseEntity
				.noContent()
				.build();
		
	}

}

---

👀 Valid

💁‍♀️ 데이터 검증(validation)이란,
클라이언트의 데이터는 조작이 쉽고, 모든 데이터가 정상적인 방식으로 들어오지 않을 가능성도 있기 때문에 Client side 뿐만 아니라 Server side에서도 데이터 유효성 검사 할 필요성 존재 !
👉 Spring boot starter validation 활용

---

🤔❓ 사용 방법
[1] 의존성 추가
[2] controller의 핸들러 메소드의 유효성 검사를 적용할 request 객체 앞에 @Validated 어노테이션 작성
[3] request를 핸들링할 객체 정의 시 @Validation 어노테이션을 통해 필요한 유효성 검사 적용

👉 pom.xml

의존성 추가

<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-validation -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-validation</artifactId>
</dependency>

👉 UserDTO

@NotNull @NotBlank @Size @DateTimeFormat @Past

public class UserDTO {
	
	private int no;
	
//	@NotNull(message = "아이디는 필수 입력 사항임다😬") // null은 허용하지 않으나 "", " "등은 허용
	@NotBlank(message = "아이디는 공백일 수 없슴다😬")	 // null, "", " " 모두 허용 X
	private String id;
	private String pwd;
	
	@Size(min=2, message="이름은 두 글자 이상 입력해야함다😬")
	private String name;
	
	@DateTimeFormat(pattern="yyyy-MM-dd")
	@Past						// @Past : 현재보다 과거, @Future : 현재보다 미래
	private Date enrollDate;
    
    /* 기본 셋팅 */
    
}

👉 UserNotFoundException

public class UserNotFoundException extends Exception {

	public UserNotFoundException(String msg) {
		super(msg);
	}
	
}

👉 ValidTestController

@Validated

@RestController
@RequestMapping("/valid")
public class ValidTestController {

	@GetMapping("/users/{userNo}")
	public ResponseEntity<?> findUserByNo() throws UserNotFoundException {
		
		boolean check = true;
		
		if(check) {
			throw new UserNotFoundException("회원 정보를 찾을 수 없어용🥺");
			
		}
		
		return ResponseEntity.ok().build();
	}

	@PostMapping("/users")
	public ResponseEntity<?> registUser(@Validated @RequestBody UserDTO user) {
		
		/* null을 반환해도 상관없으나, 미완성 같으므로 코드 추가 */
		return ResponseEntity
				.created(URI.create("/valid/users/4"))
				.build();
	}
}

👉 ErrorResponse

public class ErrorResponse {
	
	private String code;
	private String description;
	private String detail;
    
    /* 기본 셋팅 */
    
}

👉 ExceptionController

@ControllerAdvice : 컨트롤러를 보조해주는 기능을 제공한다는 것을 명시하는 어노테이션으로 해당 클래스 내에 전역 예외처리 등록 가능
@ExceptionHandler MethodArgumentNotValidException
getBindingResult() hasErrors() getFieldError() getDefaultMessage() getCode()

@ControllerAdvice
public class ExceptionController {

	@ExceptionHandler(UserNotFoundException.class)
	public ResponseEntity<ErrorResponse> handleUserException(UserNotFoundException e) {
		
		String code = "ERROR_CODE_00000";
		String description = "회원 정보 조회 실패!";
		String detail = e.getMessage();
		
		return new ResponseEntity<>(new ErrorResponse(code, description, detail), HttpStatus.NOT_FOUND);
	}
	
	@ExceptionHandler(MethodArgumentNotValidException.class)
	public ResponseEntity<ErrorResponse> mothodVaildException(MethodArgumentNotValidException e) {
		
		String code = "";
		String description = "";
		String detail = "";
		
		/* 긱기 다른 에러가 발생했을 경우, 각 메세지들이 출력되도록 함 */
		if(e.getBindingResult().hasErrors()) {
			detail = e.getBindingResult().getFieldError().getDefaultMessage(); /* UesrDTO에서 어노테이션의 message에 입력한 메세지 가져오기 */
			
			String bindResultCode = e.getBindingResult().getFieldError().getCode();
			System.out.println("bindResultCode : " + bindResultCode);
			
			switch(bindResultCode) {
			case "NotNull" :
				code = "ERROR_CODE_00001";
				description = "필수 값이 누락되었어요!";
				break;
			case "NotBlank" :
				code = "ERROR_CODE_00002";
				description = "필수 값이 공백으로 처리되었어요!";
				break;
			case "Size" :
				code = "ERROR_CODE_00003";
				description = "알맞은 크기의 값이 입력되지 않았어요!";
				break;
			case "Past" :
				code = "ERROR_CODE_00004";
				description = "알맞은 기간의 값이 입력되지 않았어요!";
				break;
			}
		}
		/* 유효성 조건에 불일치하면 code, description, detail가 출력됨 */
		return new ResponseEntity<>(new ErrorResponse(code, description, detail), HttpStatus.BAD_REQUEST);
	}
		
}

---

👀 Hateoas

👉 pom.xml

의존성 추가

<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-hateoas -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-hateoas</artifactId>
</dependency>

👉

---

👀 ??

👉