RestfulAPI , GraphQL

2024. 11. 2.원문 보기

#GrapQL#RESTfull

: Restfull API는 A가 어떤 방식으로 요청하고, B가 어떤 방식으로 응답할지 지정해 놓은 다양한 형식들 중 하나입니다.(1) Create : 정보를 생성해서 넣는 것(2) Read : 조회, 목록 또는 특정 정보를 조회하는 것 (3) Update: 정보를 업...

1. RESTful API

: RESTful API는 A가 어떤 방식으로 요청하고, B가 어떤 방식으로 응답할지 지정해 놓은 다양한 형식 중 하나입니다.

작업의 종류

(1) Create

: 정보를 생성해서 넣는 것

(2) Read
: 조회, 목록 또는 특정 정보를 조회하는 것

(3) Update

: 정보를 업데이트하는 것

(4) Delete

: 어떤 정보를 삭제하는 것

EX) URI 사용 예시

POST	https://api.example.com/v1/infos	새로운 정보 추가
GET	https://api.example.com/v1/infos	목록 받아오기
GET	https://api.example.com/v1/infos/1	1인 정보 받아오기
PUT	https://api.example.com/v1/infos/13	13인 정보 수정
PATCH	https://api.example.com/v1/infos/10	10인 정보 변경
DELETE	https://api.example.com/v1/info/50	50인 정보 삭제

=> HTTP는 RESTful API의 필수 요소는 아니지만, RESTful API의 조건을 구현하기 용이하기에 현업에서 HTTP가 주로 사용된다.

GET, DELETE
- 적은 양의 정보를 담을 수 있다.
- 쿼리 파라미터를 통해 정보를 구분하여 가져올 수 있다.
POST, PUT, PATCH
- 많은 양의 정보를 담을 수 있다.
- body라는 공간에 데이터를 실어 보낼 수 있다.

⇒ 각 메서드의 색상, 속성, URI를 통해 개발자들이 한눈에 봐도 알아볼 수 있다.

[
      {
        "id": 1,
        "code": "WD0003",
        "parentCode": "WITHDRAWAL",
        "name": "제공된 정보가 기대에 미치지 못했어요",
        "description": "제공된 정보가 기대에 미치지 못했어요",
        "orderNumber": 0,
        "tempVal1": "",
        "tempVal2": "",
        "tempVal3": ""
      },
      {
        "id": 2,
        "code": "WD0001",
        "parentCode": "WITHDRAWAL",
        "name": "필요한 정보를 다 얻었어요",
        "description": "필요한 정보를 다 얻었어요",
        "orderNumber": 0,
        "tempVal1": "",
        "tempVal2": "",
        "tempVal3": ""
      },
  ]

특징

RESTful API는 JSON 형태의 구조화된 데이터를 사용한다.
Stateless(상태가 없는) 통신
- 클라이언트의 상태 정보가 서버에 저장되지 않아야 한다.
- 클라이언트의 요청은 몇 번째 반복되든 필요한 모든 내용을 포함하고 있어야 한다.
Cacheability
- 응답을 캐싱해 두어서 가지고 있는 데이터를 DB에서 꺼내지 않고 보내줄 수 있다.