티스토리 뷰

728x90
반응형

REST(ful) API

 

API란 쉽게 말해 클라이언트를 위해 서버와의 소통법을 적어둔 매뉴얼이다.

 

이 매뉴얼의 디자인에는 BEST Choice가 존재하며, 이를 REST API라 부른다.

 

중간 내용을 건너뛰고 간단하게 정리하면 REST API란

 

  • 규칙을 통한 리소스 중심의 올바르고 유일한 엔드포인트 작성
  • 적절한 HTTP 응답 코드와 리소스에 대한 정보 기재
  • CRUD에 적합한 HTTP 메서드(POST, GET,...) 사용
  • 응답에 리소스에 대한 링크 삽입

을 모두 만족하는 API를 말한다.

 

Spring MVC의 REST API 엔드포인트(애너테이션)

 

  • @RestController = @Controller + @ResponseBody, 컨트롤러 클래스에 달아준다.

    • @Request/ResponseBody - HTTP 요청 ↔ 자바 객체를 자동으로 변환해주는 애너테이션
  • @RequestMapping = 컨트롤러로 들어온 요청을 특정 메서드와 매핑하기 위해 사용. 컨트롤러 클래스에 달아준다.

  • @GetMapping = HTTP GET 요청(리소스 조회)
    = @RequestMapping(value = "", method = RequestMethod.GET)

  • @PostMapping = HTTP POST 요청(리소스 생성)
    = @RequestMapping(value = "", method = RequestMethod.POST)

  • @PutMapping = HTTP PUT 요청(리소스 전체 변경)
    = @RequestMapping(value = "", method = RequestMethod.PUT)

  • @PatchMapping = HTTP PATCH 요청(리소스 부분 변경)
    = @RequestMapping(value = "", method = RequestMethod.PATCH)

  • @DeleteMapping = HTTP DELETE 요청(리소스 삭제)
    = @RequestMapping(value = "", method = RequestMethod.DELETE)
반응형
댓글
공지사항
최근에 올라온 글
최근에 달린 댓글
Total
Today
Yesterday
링크
«   2024/11   »
1 2
3 4 5 6 7 8 9
10 11 12 13 14 15 16
17 18 19 20 21 22 23
24 25 26 27 28 29 30
글 보관함