JAVA/SpringBoot

게시판 프로젝트 - REST API 방식

whyHbr 2023. 11. 6. 23:10
728x90
반응형

댓글 등록 기능 구현

@RestController 어노테이션과 jQuery의 Ajax를 이용해 화면의 움직임, 새로고침 없이 데이터를 주고 받는 비동기 처리에 대해 알아볼 것

 

 - REST API? Representational State Trasnsfer Application Programming Interface

. REST API는 애플리케이션을 통합하는 유연하고 간단한 방법을 제공하며, 마이크로서비스 아키텍처에서 컴포넌트를 연.결하는 가장 일반적인 방법

. HTTP URI 을 통해 자원(resource)을 명시하고 HTTP Method(POST, GET, PUT, DELETE, PATCH)  을 통해 해당 자원에 대한 CRUD을 적용하는 것을 의미한다.

 

 

rest api  방식서 사용할 수 있는 http 요청 메서드:

POST : 자원 resource 생성

GET : 자원 resource 조회

PUT : 자원 수정

PATCH : 자원 수정

DELETE :  자원 삭제

 

Resource?

리소스는 서비스를 제공하는 시스템의 자원을 의미한다. REST API에서 URI는 다음의 표와 같이 명사를 사용해 자원을 표현해야 한다. insert,update 와 같은 동사가 사용되면 REST 방식이라고 볼 수 없다.리소스의 행위는 무조건 HTTP 요청 메서드로 정의한다.

 

유형 메서드 바른 표현 잘못된 표현
댓글 등록 POST /comments /comments/insert
댓글 상세 정보 조회 GET /commets/1 /commets/select/1
댓글 수정 PUT or PATCH /comments/1 /commets/update/1
댓글 삭제 DELETE /comments/1 /commets/delete/1
댓글 리스트 조회 GET /comments /commets/

 

 

계층 관계

uri에 / 를 사용해 계층을 나타낸다. 

자원 Resource 메서드 설명
/member/{name} GET 아이디가 name인 회원을 조회
/member{name}/shop GET 아이디가 name 인 회원이 가지고 있는 모든 shop을 조회
/member/{name}/shop POST 아이디가 name인 회원의 정보를 수정
/member/{name} PATCH 아이디가 name인 회원의 정보를 수정
/member/{name}/shop[{3} DELETE 아이디가 name인 회원의 게임 중 키값(고유의 값) 이 3인 shop을 삭제
/member/{name}/shop/ GET URI가 / 로 끝나면 안된다. 잘못된 표

 

 

URI는 알파벳 소문자 권장 하이픈- 사용 가능 언더바_ 사용 안됨

 

 

728x90