Wecode 33일차

08:30 ~ 09:30 헬스장
10시 위코드 도착

RESTful API

API 시스템을 구현하기 위한 아키텍처 중에 가장 널리 사용되는 형식

RESTful API를 이해하기 위해서는 기본 배경 지식이 있어야 한다.

• URL : 해당 사이트의 특정 자원의 위치를 나타내는 유일한 주소
• HTTP Method : HTTP request가 의도한 action을 정의한 것
• Payload : HTTP request에서 server로 보내는 데이터
  -Payload 예시

{
	user_id : 1,
   	"member" : [
    	"sangyeon"
        "hyojin"
        "minkyeong"
        ]
}

RESTful API의 장점

그 자체만으로도 API의 목적이 쉽게 이해가 된다.

RESTful API 설계 규칙

1. URL 정보를 명확하게 표시

   • resource는 명사를 사용
     Ex) GET /user/1 -> GET /users/1

2. resource에 대한 행위를 HTTP Method(GET, POST, PUT, DELETE)로 표현

   • URL에 HTTP Method가 포함되선 안됨.
     Ex) GET delete/user/1 -> DELETE/users/1

   • URL에 동사가 포함되선 안됨.
     Ex) GET /user/show/1 -> GET /users/1
     Ex) POST insert/user/2 -> POST/ users/2

POST /user/signup

3. resource 사이에 연관 관계가 있는 경우

   • /리소스/고유ID/관계 있는 리소스
     Ex) GET /users/{user_id}/profile

4. URL는 /구분자를 사용하여 자원의 계층 관계를 나타내는데 사용

5. URL 마지막 문자로 /포함 X

6. 불가피하게 URI가 길어질 경우 -를 사용하여 가독성을 높임

7. _는 사용 X

8. URL 경로에는 대문자 사용을 피하도록 규정되 있음

9. 파일의 경우 payload의 포맷을 나타내기 위한 파일 확장자를 URL에 포함시키지 않음

   Ex) GET user/1/profile-photo.jpg (X)
   Ex) GET user/1/profile-photo

RESTful API 설계 예시

Status Code