JSON Server

1. Introduction

json-server는 json 파일을 사용하여 빠르게 쉽게 REST API를 구축할 수 있는 툴이다. 공부 목적이나 프로토타입, 작은 프로젝트를 위하여 서버가 필요할때에 사용하기에 적당한 툴이다.

2. Setup

2.1 json-server 설치

npm을 이용하여 json-server를 로컬 설치한다.

npm install -g json-server

2.2 db.json 파일 생성

프로젝트 루트 폴더에 아래와 같이 db.json 파일을 생성한다. db.json 파일은 데이터베이스 역할을 한다.

{
  "days": [
    {
      "id": 1,
      "day": 1
    },
    {
      "id": 2,
      "day": 2
    },
    {
      "id": 3,
      "day": 3
    }
  ],
  "words": [
    {
      "id": 1,
      "day": 1,
      "eng": "book",
      "kor": "책",
      "isDone": false
    },
    {
      "id": 3,
      "day": 2,
      "eng": "car",
      "kor": "자동차",
      "isDone": false
    },
    {
      "id": 5,
      "day": 3,
      "eng": "school",
      "kor": "학교",
      "isDone": false
    }
  ]
}```

2.3 json-server 실행

json-server가 db.json 파일을 watching하도록 실행한다.

watch 옵션 적용

json-server --watch db.json

기본 포트는 3000이다. 포트를 변경하려면 port 옵션을 추가한다.

포트 변경

json-server --watch db.json --port 3001

3. json-server 접속

Postman을 사용하여 json-server에 접속하여 보자.

3.1 GET request

3.2 POST request

3.3 PUT request

3.4 DELETE request