REST API 알아보기

떡ol·2023년 3월 28일
0

1. REST API란

REST는 Representational State Transfer라는 용어의 약자로서 2000년도에 로이 필딩 (Roy Fielding)의 박사학위 논문에서 최초로 소개되었습니다. 로이 필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시 웹(HTTP) 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다고 합니다.

2. REST 그래서 어떻게 사용하나?

위에서 REST는 장점을 최대한 활용할 수 있는 아키텍처라고 설명합니다.
정해진 틀에 맞춰 디자인함으로써 자원을 읽고 쓰기 편하게 사용하기 위해 만들어놓은 규칙인거 같습니다.

REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약할 수 있습니다.

첫 번째, URI는 정보의 자원을 표현해야 한다.
두 번째, 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현합니다.

위에 Method로 CRUD (Create,Read,Update,Delete) 할 수 있는 역할입니다.

MethodRole
GET리소스를 조회하며 상세한 정보를 읽어오는 역할을 한다.
POST리소스를 생성한다.
PUT리소스를 수정한다.
DELETE리소스를 삭제한다.

다음과 같은 식으로 URI는 자원을 표현하는 데에 집중하고 행위에 대한 정의는 HTTP METHOD를 통해 하는 것이 REST한 API를 설계하는 중심 규칙입니다.

3. 소스 작성

RestApiController.java

@RestController
@RequestMapping(value = "/api")
public class RestApiController {
	
	
	@PostMapping(value="/post/create")
	public String create(@RequestBody RestRequest create) {
		System.out.println(create.toString()); 
        //mapper.insertUserCreate(create)// 이런식으로 하면 됩니다. 여기선 따로 작성안함.
		
		return "sucess";
	}
	
	@GetMapping(value="/get/search")
	public List<RestResponse> search() {
    	// 마찬가지로 불러올때도 mapper로 불러온 자료를 넣으면 됩니다.
		List<RestResponse> result = new ArrayList<>();
		for(int i=0; i< 10; i++) {
			RestResponse rr = new RestResponse();
			rr.setSeq(i+"");
			rr.setContent("새로운 데이터"+i);
			rr.setUserId("newMyid"+i);
			result.add(rr);
		}
		
		return result;
	}
	
	//아래의 어노테이션은 생략...
	//@PutMapping("/update/{user-id}")
	//@DeleteMapping()
}

어? 뭐야 나도 이렇게 작성하는데? 이게 REST임?

ㅇㅇ 맞습니다. 이렇게 규약에 맞춰 디자인한것을 RESTful한 설계라고 합니다.

여기서 추가로 말씀드리면 Rest는 객체를 주고 받을때 json타입을 사용하기 때문에
@RestController 를 사용하여 @Controller + @ResponseBody를 동시에 사용한거처럼 사용이 가능합니다.
@GetMapping, @PostMapping, @PutMapping등은 결국 @RequestMapping를 좀 더 구체적으로 식별하는 메타 어노테이션이라고 합니다.

@Controller
@ResponseBody
public void main(){}

@RestController
public void main(){}
// 이 두개가 서로 같은겁니다. 
// @RestController 처럼 다른 어노테이션이 합쳐진걸 메타 어노테이션이라고 합니다.

앞에서 말씀드린바와 같이 REST는 자원을 읽고 쓰기 편하게 사용하기 위해 만들어놓은 규칙에 부합하는 어노테이션이 되겠네요.
마치 @service, @repository 등이 @Component를 좀 더 명확하게 구분지어 사용할려고 만든 것과 같다고 보시면 됩니다.

아래에는 불러오기를 위한 추가 controller.java , index.jsp, dto예제입니다.

controller.java

	//다른 controller에 넣어서 불러왔습니다. REST는 서버와 클라를 명확히 구분할 수 있고 관리하기 편하게 해야하므로...
	@RequestMapping(value="restApi")
	public String restApi() {
		System.out.println("이 페이지는 restApi를 위한 view페이지입니다.");
		return "restApi";
	}

index.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="EUC-KR">
<title>restTest</title>
<script  src="http://code.jquery.com/jquery-latest.min.js"></script>
</head>
<body>
유저등록
<form action="/" onsubmit="restSubmit(); return false;" name="restTest" method="post">
	ID :<input type="text" name="userId" id="userId" value="monster_1"/><br>
	SEQ :<input type="text" name="seq" id="seq" value="11"/><br>
	CONTENT :<input type="text" name="content" id="content" value="얄라리얄랴샹셩"/><br>
	PWD : <input type="text" name="pwd" id="pwd" value="1234"/><br>
	<input type="submit"/>
</form>

</body>
<script>
restTest.addEventListener("submit",function(event){
	event.preventDefault();
})

function restSubmit(){
	let create = {
		userId 	: $("#userId").val()
		,seq   	: $("#seq").val()
		,pwd   	: $("#pwd").val()
		,content: $("#content").val()
	}
	
	//어후  복붙만 해서 쓰니 js다 까먹었음..
	$.ajax({
	    url: "/api/post/create",
	    dataType: "json",
	    contentType: "application/json; charset=UTF-8",
	    type: "post",
	    data: JSON.stringify(create),
	    success: function (res) {
	    	console.log(res);
	    },
	    error: function (request, status, error) {
	    }
	});
}


</script>
</html>

RestRequest.java

@Getter
@Setter
@ToString
public class RestRequest {
	
	private String userId;
	private String seq;
	private String content;
	private String pwd;
	

}

RestResponse.java

@Getter
@Setter
@ToString
public class RestResponse {
	
	private String userId;
	private String seq;
	private String content;

}

4. RESTful한 설계 방법

아래내용은 참고에 있는 블로그에서 퍼왔습니다.

1) 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용

    http://restapi.example.com/houses/apartments
    http://restapi.example.com/animals/mammals/whales

2) URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 합니다. REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않습니다.

    http://restapi.example.com/houses/apartments/ (X)
    http://restapi.example.com/houses/apartments  (0)

3) 하이픈(-)은 URI 가독성을 높이는데 사용
URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있습니다.

4) 밑줄(_)은 URI에 사용하지 않는다.
글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 합니다. 이런 문제를 피하기 위해 밑줄 대신 하이픈(-)을 사용하는 것이 좋습니다.(가독성)

5) URI 경로에는 소문자가 적합하다.
URI 경로에 대문자 사용은 피하도록 해야 합니다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문입니다. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이지요.

 	RFC 3986 is the URI (Unified Resource Identifier) Syntax document

6) 파일 확장자는 URI에 포함시키지 않는다.

	http://restapi.example.com/members/soccer/345/photo.jpg (X)

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않습니다. Accept header를 사용하도록 합시다.

    GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

7) 리소스 간의 관계를 표현하는 방법
REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같은 표현방법으로 사용합니다.

    /리소스명/리소스 ID/관계가 있는 다른 리소스명

    GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

만약에 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있습니다. 예를 들어 사용자가 ‘좋아하는’ 디바이스 목록을 표현해야 할 경우 다음과 같은 형태로 사용될 수 있습니다.

	GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)




참고자료들___
(참고) REST API 제대로 알고 사용하기

profile
하이

0개의 댓글