REST API 를 알아보기 전에 REST가 무엇인지 먼저 알아보자.
REST(Representational State Transfer)
자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미한다.
URI를 통해 자원을 명시하고, Method (POST, GET, PUT, DELETE, PATHCH..)를 통해 자원에대한 CRUD 연산을 적용하는 것이다.
REST API
REST의 원리를 따르는 API를 의미한다. 하지만 REST API를 올바르게 설계하기 위해서는 지켜야 하는 몇가지 규칙이 있다.
REST API 설계 예시
1. URI는 동사보다는 명사를, 대문자보다는 소문자를 사용한다
⛔️ : http://localhost:xxxx/MEMOS
👍 : http://localhost:xxxx/memos
2. 마지막에 슬래시 (/)를 포함하지 않는다.
⛔️ : http://localhost:xxxx/memos/
👍 : http://localhost:xxxx/memos
3. 언더바 대신 하이폰을 사용한다.
⛔️ : http://localhost:xxxx/memos_test
👍 : http://localhost:xxxx/memos-test
4. 파일확장자는 URI에 포함하지 않는다.
⛔️ : http://localhost:xxxx/memos.jpg
👍 : http://localhost:xxxx/memos
5. 행위를 포함하지 않는다.
⛔️ : http://localhost:xxxx/delete_memos/1
👍 : http://localhost:xxxx/memos/1
RESTful API
REST의 원리를 따르는 시스템을 의미한다. 무조건 REST를 사용했다 하여 모두가 RESTful 한 것은 아니다. REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다고 한다.
'spring 스프링' 카테고리의 다른 글
REST API CrossOrigin Annotation 간단 정리 (0) | 2023.05.24 |
---|---|
REST API 기초 세팅 Postman (0) | 2023.05.23 |
JPA 오라클 테이블 생성 시 자동 할당 및 기타 @어노테이션 (0) | 2023.05.20 |
JPA로 오라클 테이블 만들기 (0) | 2023.05.20 |
[spring] 스프링 기초 설정 (0) | 2023.05.18 |