반환 방법: REST API / GraphQL

REST API

REST API는 웹에서 가장 보편적인 요청-반환 방식이다. HTTP메서드와 URI(URL)를 통해 데이터를 주고받는다.

 

1. Method

= 동사(HTTP 메서드): 어떤 행위(Method)를 할 것인지.

REST API의 HTTP 메서드는 자원에 대해 어떤 작업을 수행할지 나타내며 CRUD 연산과 직접적으로 연결되어있다.

 

CRUD란?

• Create: 데이터를 생성할 때 사용
  • HTTP 메서드: POST
  • 예시: POST /users (새로운 사용자 정보 생성)
• Read: 데이터를 읽어올 때 사용
  • HTTP 메서드: GET
  • 예시: GET /users (모든 사용자 정보를 조회), GET /users/{id} (특정 사용자 정보를 조회)
• Update: 데이터를 수정할 때 사용
  • HTTP 메서드: PUT 또는 PATCH
  • 예시: PUT /users/{id} (특정 사용자 정보를 전체 수정), PATCH /users/{id} (특정 사용자 정보를 부분 수정)
• Delete: 데이터를 삭제할 때 사용
  • HTTP 메서드: DELETE
  • 예시: DELETE /users/{id} (특정 사용자 정보를 삭제)

 

 

2. URI(URL)

= 명사(목적어): 어떤 자원(Resource)에 대해

URI는 특정 자원에 접근하는 경로를 정의하며 RESTful하게 설계된다. URI는 주로 네 가지 요소로 구성된다.

• Collection
  • 여러 개의 리소르를 포함하는 상위 디렉토리. 예를들어 여러사람들을 포함하는 People
  • 예시: '/people'
• Document
  • Collection 내의 단일 리소스.
  • 예시: '/people/12' → ID가 12인 특정 사람
• Store
  • Document의 특정 형태로, 하위 리소스 또는 다른 표현 
  • 예시: '/people/12/favorites'
• Controller
  • CRUD와 같은 기본적인 메서드 외의 추가적인 행위를 명시하기 위해 사용. 필요에 따라 URI 마지막에 추가한다.
  • 예시: '/people/12/register' (회원등록) → ID가 12인 사람에 대한 회원등록. POST 메서드 사용을 강조)

3. URI(Path)에 들어가는 변수(가변요소)

URI에는 자원에 대한 변수를 포함할 수 있으며, 이는 Path Variable 또는 Query Parameter로 표현된다.

• Path Variable: '/hellow/world'와 같이 경로의 일부로 포함
• Query Parameter: '/hellow?next=world'와 같이 URI 끝에 붙는 형식

4. Representation of Resource

=표현: REST API는 주로 JSON (JavaScript Object Notation), XML 등의 포맷으로 데이터를 표현하며 클라이언트에 전달된다.

 

 

5. HTTP Response Status / Response Code

 

• 1XX: 정보 제공
• 2XX: 성공 (예: 200 OK, 201 Created)
• 4XX: 클라이언트 오류 (예: 400 Bad Request, 404 Not Found)
• 5XX: 서버 오류 (예: 500 Internal Server Error)

 

 

---

GraphQL

REST API는 각 비지니스 도메인마다 수많은 API 들을 일일히 만들어야하는 단점이 있다. (API 싸개)

따라서 다양한 도메인과 메소드, 컨트롤러를 통해 반환. 이로 인해 수천개의 메소드와 컨트롤러가 필요할 수 있음.

→ GraphQL은 클라이언트가 필요한 데이터만 명시적으로 요청 가능. 따라서 어떤 데이터를 반환할지 서버 측에서 미리 결정해야하는 번거로움이 없음 👍

 

GraphQL의 이점

• 클라이언트가 필요한 정보만 선택적으로 가져갈 수있다
• 이를 통해 API 요청과 응답의 효율성이 ⬆️
• 예시로 클라이언트가 특정 사용자 정보와 해당 사용자의 친구 목록만 필요할 때 그 정보만 요청할 수 있다.

---

+@ 

웹 브라우저, 포스트맨, CUI 차이점

웹 브라우저: 기본적으로 GET 방식의 요청만 가능

포스트맨: 다양한 HTTP 메서드를 사용할 수 있어 백엔드 개발자가 POST, PUT, DELETE 등의 요청을 테스트할 때 유용

CUI: Command Line Interface를 통해 텍스트 기반으로 다양한 명령어를 사용하여 요청을 보낼 수 있다.

 

 

 

 

ℹ️참고

[ASAC 6기 강의자료]