REST API (basic)

BenKim·2020년 8월 12일
0
post-custom-banner

REST(Representational State Transfer) API는 정보를 주고받는데 있어서 개발자들 사이에 쓰이는 형식으로서 각 요청(HTTP)이 어떤 동작이나 정보를 위한 것인지를 그 요청의 모습 자체로 추론 가능하다.

서비스는 개발자 혼자 만들지 않기 때문에, 혹여 혼자 만들더라도 나중에 인계받을 개발자가 있고, 해당 서비스를 이용해 다른 서비스를 만들게 될 개발자들이 있기 때문에 약속된 형식을 따르는것이 권장된다.

2가지 원칙

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

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

  • get 조회 read
  • post 추가 create
  • put 정보를 통째로 변경 / patch 정보의 일부만 변경할 때
  • delete 제거

uri는 동사가 아닌 명사로 이루어져야 한다.


uri : 자원을 구조와 함께 나타내는 구분자

이외 규칙들

  • 밑줄_보다는 하이픈- 이 가독성이 좋다.
  • 소문자사용이 권장된다(대소문자에 따라 구별되기때문)
  • 정확한 응답 상태코드만으로도 많은 정보를 전달할 수가 있다.
    등등...

참고: https://www.youtube.com/watch?v=iOueE9AXDQQ
https://meetup.toast.com/posts/92

profile
연습과 자신감
post-custom-banner

0개의 댓글