RESTful API?

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


왜 사용할까?

  • 비싼 툴이 아니다
  • 진입장벽 낮음
  • 효율적인 데이터 메세지 작성
  • 조금 더 빠른 통신 가능

설계규칙


GET /users/1 이렇게 복수로 대부분쓴다 회사uri를 보고 그에 맞게 행동

동사액션 겹치면 안된다.

  • Get delete/user/1 x 이렇게 쓰면 안된다.

uri에 동사 포함 안된다

  • GET/user/show/1 이런것

  • Get /users/{user_id}/profile

파일 확장자 를 uri에 포함 ㄴㄴ

-Get /users/{user_id}/profile.png
.은 웹페이지에서 혼란을 줄수도 있다. 그래서 안씀

길어질경우 -사용해 띄어쓰기처럼 사용 _는 시스템적 오류를 낼 수도 있음

  • uri 경로는 소문자만 사용

계층사용

  • ?는 /로 닫지말아달라고 열어 두라고 표시

하나의 정보를 얻고싶으면 단수로 표현

Get/post 관계

  • Patch/put 관계의 차이를 찾아보자

delete는 바디에 안넣고 아이디 값에 넣어준다

쿼리 파라미터에서 &은 교집합느낌으로 생각

  • Offset = 어디서부터 시작
  • Limit = 어디서 끝나는지
  • 영역을 정해서 주고 받을 수 있음

Search는 말그대로 찾아주는 것



패스 파라미터는, 쿼리 파라미터
쿼리 들어가는 순간 uri 가 길어짐.

0개의 댓글

Powered by GraphCDN, the GraphQL CDN