개념정리

Rest API란

춘핑이 2023. 8. 4. 14:58

Rest API

프로젝트를 하면서, 공고를 보면서 Restful API, Restful설계 경험자를 본적이 많다.
그래서 과연 이 Restful API, Rest API, Rest가 무엇인지 정리해보려고 한다.

1. REST란?

REST(Representational State Transfer)의 약자로, 자원을 이름으로 구분해서 자원의 상태를 주고받는 모든 것을 의미한다.

AWS에서는 API 작동 방식에 대한 조건을 부과하는 소프트웨어 아키텍처라고 정의하고 있다.처음에 인터넷과 같은 복잡한 네트워크에서 통신을 관리하기 위한 지침으로 만들어졌고. REST 기반 아키텍처를 사용하여 대규모의 고성능 통신을 안정적으로 지원할 수 있다고 한다.

API 개발자는 여러 아키텍처를 사용하여 API를 설계할 수 있고 REST 아키텍처 스타일을 따르는 API를 REST API라고 한다.
REST 아키텍처를 구현하는 웹 서비스를 RESTful 웹 서비스라고 한다.
RESTful API라는 용어는 일반적으로 RESTful 웹 API를 나타내지만 지만 REST API와 RESTful API라는 용어는 같은 의미로 사용할 수 있다고 한다.

아무튼 정리하면
HTTP URI를 통해 자원을 명시하고,
HTTP Method(POST, GET, PUT, DELETE, PATCH)를 통해
해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미한다고 할 수 있다.

자원은 해당 소프트웨어가 관리하는 모든 것으로
-> Ex) 문서, 그림, 데이터, 해당 소프트웨어 자체 등
자원의 표현: 그 자원을 표현하기 위한 이름
-> Ex) DB의 학생 정보가 자원일 때, ‘students’를 자원의 표현으로 정한다.
상태(정보) 전달
데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달한다.
JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

2. REST 구성 요소

REST는 다음과 같은 3가지로 구성이 되어있다.

자원(Resource) : HTTP URI
자원에 대한 행위(Verb) : HTTP Method(POST, GET, PUT, DELETE, PATCH)
자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load

3. REST의 특징

  • Server-Client(서버-클라이언트 구조)
    • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
    • REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
    • Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
    • 서로 간 의존성이 줄어든다.3.2 Stateless(무상태)
    • HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
    • Client의 context를 Server에 저장하지 않는다.
    • 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
  • Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
    • 각 API 서버는 Client의 요청만을 단순 처리한다.
    • 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.
    • 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
    • Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.
  • Cacheable(캐시 처리 가능)
    • 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
    • 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
    • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
    • 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
    • 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.
  • Layered System(계층화)
    • Client는 REST API Server만 호출한다.
    • REST Server는 다중 계층으로 구성될 수 있다.
    • API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
    • 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
    • PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
  • Code-On-Demand(optional)
    • Server로부터 스크립트를 받아서 Client에서 실행한다.
    • 반드시 충족할 필요는 없다.
  • Uniform Interface(인터페이스 일관성)
    • URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
    • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
    • 특정 언어나 기술에 종속되지 않는다.

4. REST의 장단점

장점

HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해 준다.
HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
서버와 클라이언트의 역할을 명확하게 분리한다.

4.2 단점

표준이 자체가 존재하지 않아 정의가 필요하다.
HTTP Method 형태가 제한적이다.(POST, GET, PUT, DELETE, PATCH)
브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.(IE가 이렇다 그런데 요새는 서비스 종료이니 상관없어 보이기도 한다.)

5. REST API란?

그렇다면 결론적으로 REST API란 무엇일까? 바로 Restful하게 Rest의 규칙을 따라서 설계하는 방식이다.
어떤 특별한 기능이 아니라 이 방식을 따라 설계하여 데이터를 주고받는 방식을 의미한다고 이해했다.
하지만 REST API를 올바르게 설계하기 위해서는 지켜야 하는 몇가지 규칙이 있다.

6. REST API 설계 예시

6.1 URI는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.

예를 들어 둘다 등록하는 메소드이다.
위의 컨트롤러는 URI가 reg라는 동사형이고 밑의 컨트롤러는 notices라는 명사형이다.

@PostMapping("reg")
public String regProc(Product product,
        @RequestParam("files") MultipartFile[] files,
        RedirectAttributes rttr) {
....
}
@PostMapping("/api/notices")
public ResponseEntity<Map<String, Object>> createNotice(
        Notice notice,
        @RequestParam(value = "files", required = false) MultipartFile[] files,
        Authentication authentication) {
        ....
}

이런식으로 RESTful API에서는 리소스(자원)를 나타내기 위해 명사형을 사용한다.
RESTful API는 웹 상의 자원을 URL로 표현하는 것을 강조한다.
각각의 엔드포인트(URI)는 서버에서 제공하는 특정한 리소스를 대표하기 위해 명사형을 사용한다.

6.2 마지막에 슬래시 (/)를 포함하지 않는다.

/api/notices = ok
/api/notices != ok

6.3 파일확장자는 URI에 포함하지 않는다.

xxx.photo.jpg != ok

7. 정리

RESTFUL이란 REST의 원리를 따르는 시스템을 의미한다.
하지만 REST를 사용했다 하여 모두가 RESTful 한 것은 아니다.
REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 말할 수 있으며
모든 CRUD 기능을 POST로 처리 하는 API 혹은 URI 규칙을 올바르게 지키지 않은 것이라고 할 수 있다.

나의 경우 멀티파트 파일을 포함하는 경우가 많아서 POST요청을 많이 하긴 했지만,
수정시에 PUT PATCH 삭제시에 DELETE요청을 넣어줘야한다.

다음은 완벽하진 않지만 내가 참여기업을 등록 설계할때 적용한 Restful API이다.
participate가 너무길어 join으로 줄였지만 join은 동사의 의미가 더 강하니 joining같은 것으로 변형했어야할 것 같다.
이런식으로 다양한 요청을 처리할 필요가 있다.

@RestController("adminJoinControllerAPI")
@RequestMapping("/api/admin/join/")
@RequiredArgsConstructor
@PreAuthorize("hasAuthority('admin')")
public class JoinControllerAPI {

    private final JoinService joinService;

    @GetMapping
    public ResponseEntity<Map<String, Object>> getRecruiters(
            @RequestParam(value = "search", required = false) String search,
            @RequestParam(value = "type", required = false) String type,
            @RequestParam(value = "status", required = false) String status,
            @RequestParam(value = "page", defaultValue = "1") Integer page) {
        Map<String, Object> result = joinService.getList(search, type, page, status);
        return ResponseEntity.ok(result);
    }

    @GetMapping("{companyId}")
    public ResponseEntity<Map<String, Object>> getRecruiterDetail(@PathVariable("companyId") Integer companyId) {
        Map<String, Object> result = joinService.getDetail(companyId);
        return ResponseEntity.ok(result);
    }

    @PatchMapping("{companyId}")
    public ResponseEntity<Void> updateRecruiterStatus(
            @PathVariable("companyId") Integer companyId,
            @RequestBody Map<String, String> statusMap) {
        boolean ok = joinService.changeStatus(companyId, statusMap);
        if (ok) {
            return ResponseEntity.ok().build(); // 200 OK 응답
        } else {
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build(); // 500 내부 서버 오류 응답
        }
    }
}

8. 마지막 느낀점

정말 정말 마지막으로 느낀점은
기존 form태그로 데이터를 받아와서 설계하는 것이나 Restful하게 설계하는 것이나 내부적으로는 비슷하다.
그러나 View에서 꺼내보았을 때 Restful API는 주로 Json으로 값을 반환하기 때문에 요청 상태에 따라 이 값을 자유롭게 사용할 수 있도록 하는 점에서 장점이 있다고 보였다.
그런데 저번 프로젝트에서 너무 날먹으로 api만 주구장창찍어보니 원래 것을 제대로 기억못하는 단점도 생겼었다. ㅎㅎ;
각자의 장점을 살려서 작성하는 것이 좋아보인다.
만약 JSP가 아니라 React, Vue였다면 더 활용성이 좋았을 것이라는 생각이 든다.