[Network] - REST API ?

전에 REST API를 알기 위해서 REST에 대해서 공부를 해보았습니다.

이제 여기에 + API 인 REST API란 무엇일까에 대해서 알아보겠습니다.

 

API ?

먼저 REST를 알아보았으니 API도 뭔지 알아봐야겠죠?

API(Application Programming Interface) : 프로그램끼리 서로 기능이나 데이터를 주고 받을 수 있도록 정해놓은 규칙

 

이렇게 api는 정보 교환을 원활하게 하기 위해서 만든 규칙이라고 생각하면 될 것 같습니다. 

 

REST API ?

이를 통해 알 수 있는 REST API는 REST의 규칙을 따르면서 만든 API라고 보시면 될 것 같습니다.

이를 위해서 디자인 가이드가 있는데요. 이를 소개하겠습니다.

 

REST API 디자인 가이드

1. 자원은 명사로 표시하기 (동사 x)

GET /users → 사용자 목록 조회
POST /users → 새 사용자 생성
GET /users/1 → 1번 사용자 정보 조회
PUT /users/1 → 1번 사용자 정보 수정
DELETE /users/1 → 1번 사용자 삭제

 

이렇게 유저에 대한 데이터를 처리를 할때 users 처럼 명사로 표시를 해야한다는 것입니다.

 

2. HTTP 메소드 활용하기 : 자원에 대한 CRUD 작업은 HTTP 메소드를 활용하여 표현해야 한다

또한 이에 대한 작업을 URI에 표시를 하면 안됩니다.

GET /users (Good)
GET /getusers (Bad)

 

3. 하이픈을 통해 URI 가독성 높이기 _ 사용 금지

4. URI 경로는 소문자를 사용하기

5. 파일확장자는 URI에 포함하지 않기

6. 자원 간의 연관성이 있는경우

Ex) GET : /users/{userid}/posts