REST API

베오·2023년 3월 15일
0

나를 위해, 시간이 아까운 분들을 위해 간단히 쓰도록 하겠다.

REST API는
자원(resource)-url, 행위(verb)-http method, 표현(representations)로 이루어졌으며 이 3가지를 규칙에 맞게 쓰는 인터페이스라고 보면 됩니다.

요약

  • URL은 정보의 자원을 표현
  • 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현

규칙

  • 리소스명은 명사만 쓰여야 한다
  • 자원에 대한 행위는 Method로 표현
  • /는 계층 관계를 표현
  • URL 마지막에 /를 넣지 않는다
  • _대신 -를 활용해라
  • 소문자만 써라
  • 파일 확장자를 넣지 마라

간혹 show나 create 등을 url에 쓰는 경우가 있는데 그걸 하지 말란 거다. 행위를 Method로 쓰라는 거다.

Method 역할
POST: CREATE
GET: READ
PUT: UPDATE
(간혹) PATCH: UPDATE (일부만 수정)
DELETE: DELETE

4가지 또는 5가지 있다.

이외의 상태 코드는 내가 아직 쓰지 않아서 더 자세한 내용은 링크를 보고 이해하길 바란다.

규칙이라고 이해하면 된다.

관련 내용:
https://meetup.nhncloud.com/posts/92

https://www.youtube.com/watch?v=PmY3dWcCxXI

profile
꿈을 현실로

0개의 댓글

Powered by GraphCDN, the GraphQL CDN