json-server를 사용해보자

최근에 json-server를 통해 간단하게 프로젝트를 수행했다. 간단하게 사용할 수 있는 테스트 서버 느낌이었는데, 알아두면 유용할 것 같아서 정리해두려고 한다.

json-server란

json-server란, 가짜 API 서버를 만드는 툴이다. 짧은 시간동안 REST API가 필요할 때, 간단하게 만들어서 테스트해 볼 수 있다. API가 만들어지기 전에 연결 작업을 진행할 때 사용하면 유용할 것 같다.

설치와 사용방법 모두 간단하다. 먼저, npm(or yarn)을 통해 설치한다.

npm i -g json-server
yarn global add json-server

먼저, 폴더를 생성하고 폴더 아래에 db.json파일을 만들었다. 파일 안에는 아래와 같이 member이라는 이름의 배열을 만들어서 멤버의 정보를 담고 있는 형태로 저장하였다. 이제 끝났다!

{
  "member": [
    {
      "id": 1,
      "userName": "김말똥",
      "phoneNumber": "010-1111-1234",
      "position": "개발"
    },
    {
      "id": 2,
      "userName": "아무개",
      "phoneNumber": "010-2222-1234",
      "position": "디자인"
    }
  ]
}

아래 명령어로 실행해보자!
json-server --watch db.json --port 3001

그럼 다음과 같이 포트번호를 통해 내가 만든 db.json을 볼 수 있다. 한번 API 테스트를 진행해보자!

아래 테스트 화면처럼 db.json을 이용해서 간단하게 조회, 추가, 수정, 삭제 잡업을 실행할 수 있다. 또한, json-server는 페이징, 필터링, 정렬등의 기능도 지원한다.

이 외에도 데이터의 수를 _limit을 통해 제한하거나 _sort와 _order를 사용한 간단한 정렬 기능을 설정할 수 있다.

/member?_limit=20
/member?_sort=id&order=DESC
/member?_sort=position&order=ASC

궁금한 건 공부하고 바로바로 정리해두자!

json-server