REST API

Taro·2023년 10월 26일

REST API 란?

REpresentational State Transfer 라는 용어의 약자로서 REST 의 원리를 따르는 API를 의미한다

  • HTTP URI(Uniform Resource Identifier) 를 통해 자원(Resource)를 명시

  • HTTP Method(POST, GET, PUT, DELETE, PATCH ) 를 이용하여

  • 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미합니다.

CRUD

기본적인 데이터 처리 기능인 Create, Read , Update , Delete 를 묶어서 일컫는 말

METHODOPERATION
POSTPOST를 통해 해당 URI를 요청하면 리소를 생성
GETGET를 통해 해당 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.
PUTPUT를 통해 해당 리소스를 수정
DELETEDELETE를 통해 리소스를 삭제

REST API 설계 규칙

1. 슬래시 구분자는 / 계층 관계 나타낼경우 사용

 http:// rest.ex.com./server/dist

2. URI 마지막 문자엔 / 포함하지 않는다

 http:// rest.ex.com./server/dist/ (x)
 http:// rest.ex.com./server/dist  (0)

3. 밑줄(_) 은 URI 사용하지 않는다

4. URI 경로는 소문자가 적합하다

5. 하이픈(-) 은 가독성을 높이는데 사용한다

6. 파일 확장자는 URI 에 포함시키지 않는다

http:// rest.ex.com./server/dist/photo.jpg  (x)
profile
기록하며 공부하는곳

0개의 댓글