json-server

json-server

1. json-server

• json-server에 대해 알아봅시다!
• json-server란? JSON 파일을 기반으로 아주 짧은 시간에 RESTful API를 구축할 수 있게 해주는 도구입니다.
• 개발 중에 API 서버가 필요할 때, 또는 프로토타입을 빠르게 만들고 테스트하기 위해 유용하게 사용할 수 있습니다.

 

2. 특징

• json-server는 빠른 시간안에 로컬에서 실행 가능한 RESTful API 서버를 구축할 수 있습니다.
• 또한, 단일 JSON 파일을 DB로 사용합니다.
• 기본 CRUD 기능을 자동으로 제공합니다.
• 쿼리 매개변수를 사용하여 데이터 검색, 필터링 및 페이징을 지원합니다.
• 프로덕션의 활용은 불가능합니다.

 

3. 설치

• 다음과 같이 입력하여 설치할 수 있습니다. (npm 기준)
• ※ 이때, -g는 전역적(global)으로, 설치된 패키지를 시스템 전체에서 사용할 경우, 입력합니다.

npm install -g json-server

 

4. 사용

• #1. 먼저, API 서버의 DB로 사용할 JSON 파일을 만든 후, 다음과 같이 입력해 줍니다.

data.json

{
  "posts": [
    { "id": 1, "title": "Hello World!" }
  ],
  "comments": [
    { "id": 1, "body": "Good Posting!", "postId": 1 }
  ]
}

 

• #2. 다음과 같은 json-server 명령어를 사용하여, JSON 파일을 로드하고 서버를 시작합니다.

json-server --watch data.json

 

• ※ 특정 포트를 원할 경우 다음과 같이 입력합니다.

json-server --watch data.json --port 4000 # 4000 : port 번호

 

• #3. 서버가 실행되면, data.json 파일의 데이터에 접근할 수 있는 RESTful 엔드포인트가 자동으로 생성됩니다.
• 예시 (ex)
  • GET /posts : 모든 게시글 가져오기
  • GET /posts/1 : ID가 1인 게시글 가져오기
  • POST /posts : 새로운 게시글 생성
  • PUT /posts/1 : ID가 1인 게시글 수정
  • DELETE /posts/1 : ID가 1인 게시글 삭제

 

5. 정리하며

• 지금까지 json-server에 대해 알아보았습니다.
• json-server는 주로 테스트 목적으로 사용되며, 초기 개발 단계에서는 매우 유용한 도구입니다.