외곈 World 👽🌏

🎈 JSON Server 사용하기

1. REST / REST API / Json Server

• REST: 웹의 기본 프로토콜인 HTTP 를 기반으로 구현되며 , HTTP 메서드와 URL 을 이용하여 자원과 하고자하는 행동을 표현함.
• REST API: REST 한 방식으로 설계된 API.
• Json Server: JSON 파일을 이용하여 Rest API 서버를 빠르고 간단하게 생성 하기 위한 도구. 
  ex) (GET) http://example.com/wedding/1 : 1번 id 청첩장 가져오기

2. JSON Server 사용하기

https://github.com/typicode/json-server

01. JSON Server 설치

yarn add -D json-server

• 루트경로에 db.json 생성

{
  "posts": [
    { "id": "1", "title": "a title", "views": 100 },
    { "id": "2", "title": "another title", "views": 200 },
    { "id": "3", "title": "json-server", "views": 200 }

  ],
  "comments": [
    { "id": "1", "text": "a comment about post 1", "postId": "1" },
    { "id": "2", "text": "another comment about post 1", "postId": "1" }
  ],
  "profile": {
    "name": "typicode"
  }
}

• package.json에 아래 내용 추가

"dev:db": "json-server --watch db.json --port=8888" 
// watch옵션을 주면 db.json의 변경사항을 개발서버에 실시간 반영해준다.

• 실행

yarn dev:db

02. 동작 test (https://github.com/typicode/json-server?tab=readme-ov-file)

• Filter
  

  

  •  title이 json-server인 데이터 불러오기 테스트
    http://localhost:8888/posts?title=json-server
• 실행결과 
  

  

  
  
• Paginate
  Use _page and optionally _limit to paginate returned data. In the Link header you'll get first, prev, next and last links.
  

  GET /posts?_page=7   
  ​

  • _page=7 : 일곱 번째 페이지를 요청한다.
  • _limit 파라미터가 명시되지 않았으므로, json-server는 기본적으로 페이지당 10개의 항목을 반환한다.
  • 결과 : 기본 페이지당 10개 항목을 사용해 61~70번째 데이터를 반환한다.

  GET /posts?_page=7&_limit=20
  

  • _page=7: _page=7으로 일곱 번째 페이지를 요청한다.
  • _limit: _limit=20을 지정하여 페이지당 20개의 항목을 가져온다.
  • 일곱 번째 페이지에서 20개의 항목을 반환한다. 따라서, posts 데이터 중 121번째에서 140번째 항목까지를 반환한다. 
• Sort
  _sort=f1,f2
  데이터를 특정 필드를 기준으로 정렬할 수 있다. 정렬할 때는 쿼리 파라미터 _sort를 사용하고, 정렬 순서는 기본적으로 오름차순이며, 내림차순으로 설정하려면 필드 앞에 -를 붙인다.
  

  GET /posts?_sort=id,-views

  1. GET /posts?_sort=id
  • id 필드를 기준으로 오름차순 정렬
  • posts 데이터가 id 값이 작은 순서대로 정렬되어 반환 된다.
  2. GET /posts?_sort=-views
  • views 필드를 기준으로 내림차순 정렬합니다.
  • posts 데이터가 views 값이 큰 순서대로 정렬되어 반환 된다.
  3. 다중 정렬 예시: GET /posts?_sort=id,-views
  • 여러 개의 필드를 정렬 기준으로 사용할 수 있으며, id 필드를 오름차순으로 먼저 정렬한 다음, 동일한 id 값이 있을 경우 views 필드를 기준으로 내림차순 정렬한다.
  • 우선 id 값이 작은 순서대로 정렬되며, 같은 id 값을 가진 항목들은 views 값이 큰 순서대로 정렬된다.