Rest API 의 개념과 기본규칙

Rest API

REST API 는 웹 기반의 응용 프로그램에서 데이터를 송수신하기 위한 아키텍처 스타일이다. REST는 프로토콜을 기반으로 하며, 클라이언트와 서버 간의 통신을 위한 표준화된 방법을 제공한다. REST API는 웹 서비스를 개발하고 통합하는 데 매우 일반적으로 사용되며, 다양한 플랫폼 간에 데이터를 교환하는 데 유용하다.

 

Rest API 의 기본규칙

1. URI는 정보의 자원을 표현해야 한다.

2. resource 는 동사보다 명사를, 대문자보다는 소문자를 사용한다. resource의 스토어 이름으로는 복수 명사를 사용해야 한다.

3. 자원에 대한 행위는 HTTP Method (GET, POST, PUT, DELETE 등) 으로 표현한다.

4. HTTP Method나 동사표현이 URI에 들어가면 안된다. id 와 같이 변하는 값은 하나의 특정 resource 를 나타내는 고유값이어야 한다. 흔히 하는 실수는 URI에 자원에 대한 행위를 넣는 것이다. 링크가 동작을 예측할 수 있으면 보안적으로 좋지 않다.

// 잘못된 사례 → 경로에 들어간 값들을 잘라내서 사용
GET /chatrooms/get/:id
POST /chatrooms/create
GET /chatrooms/delete/:id
POST /chatrooms/update/:id
위 잘못된 사례는 아래와 같이 고칠 수 있습니다.

// 올바른 사례
GET /chatrooms     => 전체검색
GET /chatrooms/:id   =>id로 하나 검색
POST /chatrooms	  => 추가
DELETE /chatrooms/:id  =>삭제
PUT /chatrooms/:id      =>전체수정

 

 

HTTP Method

주로 쓰는 Method

CRUD	HTTP	URI
전체 리소스 조회	GET	/resources
특정 리소스 조회	GET	/resources/:id
리소스 생성	POST	/resources
리소스 전체 수정	PUT	/resources/:id
리소스 일부 수정	PATCH	/resources/:id
특정 리소스 삭제	DELETE	/resources/:id

 

GET/POST는 method 경로로 사용할 수 있다. 나머지는 Ajax 를 이용하여 전송한다.

 

 

https://skylarcoding.tistory.com/120

RestApi, Spring JWT 토큰기반 인증(로그인)