[AI 웹개발 취업캠프] 20Day - 백엔드 Rest API(2)

Rest API

API 디자인 규칙

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

리소스명은 동사보다는 명사를 사용

URI는 자원을 표현하는데 중점을 두어야 한다.

 

GET /members/post/1

처럼 post, delete 와 같은 행위에 대한 표현이 들어가서는 안된다.

 

자원에 대한 행위는 HTTP Method로 표현해야 한다

아래와 같이 표현해야 한다

POST /members/1

Method	역할
GET	조회
POST	생성
PATCH	일부분 수정
PUT	전체 수정
DELETE	삭제

 

계층 관계를 나타낼때는 슬래시 구분자(/) 사용

/houses/apartments
/animals/mammals/whales

 

주의 URL 마지막 문자로 슬래시(/)를 포함하지 않는다.

 

하이픈(-)은 URI 가독성을 높이는데 사용

URI를 쉽게 읽고 해석하기 위해

하이픈을 사용해 가독성을 높인다.

 

밑줄(_)은 URI에 사용 X

밑줄은 보기 어렵거나 문자를 가려지기도 해

이런 문제를 피하기 위해 밑줄 대신 하이픈을 사용하는게 좋다.

 

URI 경로에 대문자, 파일 확장자 사용 X

1. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정 파일확장자는 URI에 포함하지 않는다.
2. REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.

 

리소스 간의 관계를 표현이 필요할 경우

/리소스명/리소스 ID/관계가 있는 다른 리소스명
GET /users/{userid}/devices

 

---

참고 링크

REST API 제대로 알고 사용하기 : NHN Cloud Meetup

 

본 후기는 정보통신산업진흥원(NIPA)에서 주관하는 <AI 서비스완성! AI+웹개발 취업캠프 - 프론트엔드&백엔드> 과정 학습/프로젝트/과제 기록으로 작성되었습니다.