json-server란

json-server란 개발단계에서 서버의 db형태를 실험 해볼수 있는 가짜 api 서버를 만들수 있는 툴이다. 짧은 시간동안 테스트해볼 rest api 서버가 필요할때 간단하게 만들어서 테스트를 해볼수 있다. 정식적인 API가 만들어지기 전에 연결 작업을 진행 할때 사용하면 유용하다.

json-server사용법

1. 패키징 명령어 입력

• npm
  npm install json-server
• yarn
  yarn add json-server
  yarn add json-server -D # 개발 환경인 경우, -D 옵션을 함께 입력

2. db.json파일 생성 및 내용 작성

아래 이미지처럼 프로젝트 루트 경로에 db.json이라는 파일을 생성한다.

그후 아래에 다음과 같은 내용으로 객체를 만든다.

{
  "todos": [
    {
      "id": 1,
      "title": "json-server",
      "content": "json-server를 배워봅시다."
    }
  ]
}

3. 터미널을 이용해 서버 실행하기

서버를 활성화 하려면 우선 리엑트가 실행중인 터미널이 아닌 다른 터미널을 열어서 다음과 같은 명령어를 통해 json-server를 실행한다.
(필자는 yarn을 사용하기 때문에 yarn 위주로 설명할것이다.)

• yarn json-server db.json --port 4000
  
  다음과 같은 이미지가 나오면 서버 실행이 완료 된것이며, api가 활성화가 된것이다!
  그런다음 endpoints에 나온 주소값으로 이동 후, db.json에 작성한 객체가 그대로 나오는것까지 확인하면 완벽하다!
  (주소값을 입력하면 get요청을 한것이다.)

(2024.09.06 TIL)