REST API와 REST ful한 REST API 작성방법

 

REST API 란?

REST API는 URI를 사용하여 리소스을 처리한다. 이 문장만 보면 쉽게 이해가 가지 않을것이다.
예시를 들자면 커뮤니티 서비스가 있고 커뮤니티 서비스 존재하는 회원정보와 게시글들이 리소스를 뜻한다.
그런 데이터들을 URL을 통해 관리하고 처리하는 것을 REST API라고 한다. 

 

따라서 리소스를 관리하는데 있어 URl의 이름을 잘 지정하면 API가 직관적이고 사용하기 쉽다.

우리는 그런 잘 작성된 URL을 REST ful 하다고 한다. 그럼 어떻게 해야 REST ful한 REST API를 만들수 있을까?

 

 

 

REST ful한 REST API 작성방법

• REST API 리소스 명명 가이드

이 게시글 번역해서 요약하자며 아래와 같다.

 

1. 데이터를 주고 받을때는 JSON 포맷 을 사용한다.
2. URL을 언제나 명사만 들어가야 한다.
3. 리소스간의 계층 구조는 슬래시( / ) 를 사용하여 나타낸다.
4. URL의 마지막에 슬래시( / ) 는 붙이지 않는다.
5. URL의 띄어쓰기는 없고 대신 하이픈( - )을 사용하여 나타낸다. 
6. URL을 왠만하면 소문자로 작성하며 밑줄( _ )은 사용하지 말자.
7. URL에 CRUD 함수이름은 사용하지 말자