Web API


디자인 가이드

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

  • GET /members/del/1 (x) - 동사로 삭제를 표현하면 안된다. 다른 명령도 마찬가지이다.
  • DELETE /members/1 (0)

자원에 대한 행위는 HTTP Method(GET, POST, DELETE)로 표현한다.

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

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

상태코드

성공

클라이언트로 인한 오류

서버로 인한 오류

profile
do for me

0개의 댓글