JS (44) - REST API

최조니·2022년 9월 9일

JavaScript

목록 보기

36/36

44.1 REST API의 구성

REST API는 자원, 행위, 표현의 3가지 요소로 구성됨
REST는 자체 표현 구조로 구성되어 REST API만으로 HTTP 요청의 내용을 이해할 수 있음

구성 요소	내용	표현 방법
자원	자원	URI(엔드 포인트)
행위	자원에 대한 행위	HTTP 요청 메서드
표현	자원에 대한 행위의 구체적 내용	페이로드

44.2 REST API 설계 원칙

RESTful API 설계의 중심 규칙
URI는 리소스를 표현하는데 집중하고, 행위에 대한 정의는 HTTP 요청 메서드를 통해 한다.

1) URI는 리소스를 표현해야 함

URI는 리소스를 표현하는데 중점을 두어야 함
리소스를 식별할 수 있는 이름은 동사보단 명사를 사용
- 이름에 get 같은 행위에 대한 표현이 들어가선 안됨

# bad ❌
GET /getTodos/1
GET /todos/show/1

# good ⭕️
GET /todos/1

2) 리소스에 대한 행위는 HTTP 요청 메서드로 표현

HTTP 요청 메서드는 클라이언트가 서버에게 요청의 종류와 목적을 알리는 방법
주로 5가지 요청 메서드를 통해 CRUD 구현
- GET, POST, PUT, PATCH, DELETE

HTTP 요청 메서드	종류	목적	페이로드
GET	index/retrieve	모든/특정 리소스 취득	X
POST	create	리소스 생성	O
PUT	replace	리소스의 전체 교체	O
PATCH	modify	리소스의 일부 수정	O
DELETE	delete	모든/특정 리소스 삭제	X

리소스에 대한 행위는 HTTP 요청 메서드를 통해 표현하며, URI에 표현하지 않음

# bad ❌
GET /todos/delete/1

# good ⭕️
DELETE /todos/1

44.3 JSON Server를 이용한 REST API 실습

1) JSON Server 설치

2) db.json 파일 생성

프로젝트 루트 폴더에 다음과 같은 db.json 파일 생성
해당 파일은 리소스를 제공하는 데이터베이스 역할

{
  "todos": [
    {
      "id": 1,
      "content": "HTML",
      "completed": true
    },
    {
      "id": 2,
      "content": "CSS",
      "completed": false
    },
    {
      "id": 3,
      "content": "Javascript",
      "completed": true
    }
  ]
}

3) JSON Server 실행

package.json 파일의 scripts를 다음과 같이 수정
터미널에 npm start 명령어 입력하여 실행

{
  "name": "json-server-exam",
  "version": "1.0.0",
  "scripts": {
    "start": "json-server --watch db.json"
  },
  "devDependencies": {
    "json-server": "^0.16.1"
  }
}

4) GET 요청

todos 리소스에서 모든 todo를 취득

JSON Server의 루트 폴더에 public 폴더를 생성하고 JSON Server를 중단하고 재실행
public 폴더에 다음 get_index.html을 추가하고 http://localhost:3000/get_index.html 접속

<!DOCTYPE html>
<html>
<body>
  <pre></pre>
  <script>
    // XMLHttpRequest 객체 생성
    const xhr = new XMLHttpRequest();

    // HTTP 요청 초기화
    // todos 리소스에서 모든 todo를 취득(index)
    xhr.open('GET', '/todos');

    // HTTP 요청 전송
    xhr.send();

    // load 이벤트는 요청이 성공적으로 완료된 경우 발생한다.
    xhr.onload = () => {
      // status 프로퍼티 값이 200이면 정상적으로 응답된 상태다.
      if (xhr.status === 200) {
        document.querySelector('pre').textContent = xhr.response;
      } else {
        console.error('Error', xhr.status, xhr.statusText);
      }
    };
  </script>
</body>
</html>

todos 리소스에서 id를 사용하여 특정 todo 취득

public 폴더에 다음 get_retrieve.html을 추가하고 http://localhost:3000/get_retrieve.html 접속

<!DOCTYPE html>
<html>
<body>
  <pre></pre>
  <script>
    // XMLHttpRequest 객체 생성
    const xhr = new XMLHttpRequest();

    // HTTP 요청 초기화
    // todos 리소스에서 id를 사용하여 특정 todo를 취득(retrieve)
    xhr.open('GET', '/todos/1');

    // HTTP 요청 전송
    xhr.send();

    // load 이벤트는 요청이 성공적으로 완료된 경우 발생한다.
    xhr.onload = () => {
      // status 프로퍼티 값이 200이면 정상적으로 응답된 상태다.
      if (xhr.status === 200) {
        document.querySelector('pre').textContent = xhr.response;
      } else {
        console.error('Error', xhr.status, xhr.statusText);
      }
    };
  </script>
</body>
</html>

5) POST 요청

todos 리소스에 새로운 todo 생성

POST 요청 시에는 setRequestHeader 메서드를 사용하여 요청 몸체에 담아 서버로 전송할 페이로드의 MIME 타입을 지정해야 함
public 폴더에 다음 post.html을 추가하고 http://localhost:3000/post.html 접속

<!DOCTYPE html>
<html>
<body>
  <pre></pre>
  <script>
    // XMLHttpRequest 객체 생성
    const xhr = new XMLHttpRequest();

    // HTTP 요청 초기화
    // todos 리소스에 새로운 todo를 생성
    xhr.open('POST', '/todos');

    // 요청 몸체에 담아 서버로 전송할 페이로드의 MIME 타입을 지정
    xhr.setRequestHeader('content-type', 'application/json');

    // HTTP 요청 전송
    // 새로운 todo를 생성하기 위해 페이로드를 서버에 전송해야 한다.
    xhr.send(JSON.stringify({ id: 4, content: 'Angular', completed: false }));

    // load 이벤트는 요청이 성공적으로 완료된 경우 발생한다.
    xhr.onload = () => {
      // status 프로퍼티 값이 200(OK) 또는 201(Created)이면 정상적으로 응답된 상태다.
      if (xhr.status === 200 || xhr.status === 201) {
        document.querySelector('pre').textContent = xhr.response;
      } else {
        console.error('Error', xhr.status, xhr.statusText);
      }
    };
  </script>
</body>
</html>

6) PUT 요청

특정 리소스 전체를 교체할 때 사용

todos 리소스에서 id로 todo를 특정하여 id를 제외한 리소스 전체를 교체
PUT 요청 시에는 setRequestHeader 메서드를 사용하여 요청 몸체에 담아 서버로 전송할 페이로드의 MIME 타입을 지정해야 함
public 폴더에 다음 put.html을 추가하고 http://localhost:3000/put.html 접속

<!DOCTYPE html>
<html>
<body>
  <pre></pre>
  <script>
    // XMLHttpRequest 객체 생성
    const xhr = new XMLHttpRequest();

    // HTTP 요청 초기화
    // todos 리소스에서 id로 todo를 특정하여 id를 제외한 리소스 전체를 교체
    xhr.open('PUT', '/todos/4');

    // 요청 몸체에 담아 서버로 전송할 페이로드의 MIME 타입을 지정
    xhr.setRequestHeader('content-type', 'application/json');

    // HTTP 요청 전송
    // 리소스 전체를 교체하기 위해 페이로드를 서버에 전송해야 한다.
    xhr.send(JSON.stringify({ id: 4, content: 'React', completed: true }));

    // load 이벤트는 요청이 성공적으로 완료된 경우 발생한다.
    xhr.onload = () => {
      // status 프로퍼티 값이 200이면 정상적으로 응답된 상태다.
      if (xhr.status === 200) {
        document.querySelector('pre').textContent = xhr.response;
      } else {
        console.error('Error', xhr.status, xhr.statusText);
      }
    };
  </script>
</body>
</html>

7) PATCH 요청

PATCH는 특정 리소스의 일부를 수정할 때 사용
예제에서는 todos 리소스의 id로 todo를 특정하여 completed만 수정
PATCH 요청 시에는 setRequestHeader 메서드를 사용하여 요청 몸체에 담아 서버로 전송할 페이로드의 MIME 타입을 지정해야 함
public 폴더에 다음 patch.html을 추가하고 http://localhost:3000/patch.html 접속

<!DOCTYPE html>
<html>
<body>
  <pre></pre>
  <script>
    // XMLHttpRequest 객체 생성
    const xhr = new XMLHttpRequest();

    // HTTP 요청 초기화
    // todos 리소스의 id로 todo를 특정하여 completed만 수정
    xhr.open('PATCH', '/todos/4');

    // 요청 몸체에 담아 서버로 전송할 페이로드의 MIME 타입을 지정
    xhr.setRequestHeader('content-type', 'application/json');

    // HTTP 요청 전송
    // 리소스를 수정하기 위해 페이로드를 서버에 전송해야 한다.
    xhr.send(JSON.stringify({ completed: false }));

    // load 이벤트는 요청이 성공적으로 완료된 경우 발생한다.
    xhr.onload = () => {
      // status 프로퍼티 값이 200이면 정상적으로 응답된 상태다.
      if (xhr.status === 200) {
        document.querySelector('pre').textContent = xhr.response;
      } else {
        console.error('Error', xhr.status, xhr.statusText);
      }
    };
  </script>
</body>
</html>

8) DELETE 요청

todos 리소스에서 id를 사용하여 todo를 삭제
public 폴더에 다음 delete.html을 추가하고 http://localhost:3000/delete.html 접속

<!DOCTYPE html>
<html>
<body>
  <pre></pre>
  <script>
    // XMLHttpRequest 객체 생성
    const xhr = new XMLHttpRequest();

    // HTTP 요청 초기화
    // todos 리소스에서 id를 사용하여 todo를 삭제한다.
    xhr.open('DELETE', '/todos/4');

    // HTTP 요청 전송
    xhr.send();

    // load 이벤트는 요청이 성공적으로 완료된 경우 발생한다.
    xhr.onload = () => {
      // status 프로퍼티 값이 200이면 정상적으로 응답된 상태다.
      if (xhr.status === 200) {
        document.querySelector('pre').textContent = xhr.response;
      } else {
        console.error('Error', xhr.status, xhr.statusText);
      }
    };
  </script>
</body>
</html>

최조니

Hello zoni-World ! (◍ᐡ₃ᐡ◍)

이전 포스트

JS (44) - REST API

JavaScript

44.1 REST API의 구성

44.2 REST API 설계 원칙

1) URI는 리소스를 표현해야 함

2) 리소스에 대한 행위는 HTTP 요청 메서드로 표현

44.3 JSON Server를 이용한 REST API 실습

1) JSON Server 설치

2) db.json 파일 생성

3) JSON Server 실행

4) GET 요청

todos 리소스에서 모든 todo를 취득

todos 리소스에서 id를 사용하여 특정 todo 취득

5) POST 요청

todos 리소스에 새로운 todo 생성

6) PUT 요청

특정 리소스 전체를 교체할 때 사용

7) PATCH 요청

8) DELETE 요청

JS (39) - DOM

0개의 댓글