Web API란?

Web API 디자인 가이드

• URI는 정보의 자원을 표현해야 한다.
• 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

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

 

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

• GET /members (O)
  : 위의 표현은 맴버의 모든 정보를 달라는 요청입니다.
• GET /members/delete/1 (X)
  : GET은 정보를 요청할 때 사용합니다. 위와 같이 동사로 삭제를 표현하면 안 됩니다.
• DELETE /members/1 (O)
  : HTTP Method 중의 하나인 DELETE를 이용하여 삭제를 표현해야 합니다
• GET /members/1                  (O)
• GET /members/get/1             (X)
• GET /members/add               (X)
• POST /members                    (O)
• GET /members/update/1        (X)
• PUT /members/1                  (O)
• GET /members/del/1             (X)
• DELETE /members/1              (O)

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

http://domain/houses/apartments 

http://domain/departments/1/employees

• URI 마지막 문자로 슬래시 구분자(/)를 포함하지 않습니다.
• 하이픈(-)은 URI의 가독성을 높일 때 사용합니다.
• 언더바(_)는 사용하지 않습니다.
• URI경로는 소문자만 사용합니다.
• RFC 3986(URI 문법 형식)은 URI스키마와 호스트를 제외하고는 대소문자를 구별합니다.
• 파일 확장자는 URI에 포함하지 않습니다.
• Accept Header를 사용합니다.

상태 코드 (성공)

 

 

상태 코드 (클라이언트로 인한 오류)

상태 코드 (서버로 인한 오류)

 

참고 URL

• https://www.edwith.org/boostcourse-web/lecture/16741/