json server

JSON-SERVER

중요한

베타 V1 문서보기 - 사용 가능하지만 변경 사항을 예상합니다. 안정적인 버전은 여기를 참조하십시오

여기요! React, Vue 또는 Astro 사용? 내 새 프로젝트 Mistcss를 확인하여 50% 적은 코드를 작성하십시오.

설치하다

npm install json-server

용법

db.json 또는 db.json5 파일을 만듭니다

{
  "posts" : [
    { "id" : " 1 " , "title" : " a title " , "views" : 100 },
    { "id" : " 2 " , "title" : " another title " , "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 "
  }
}

DB.JSON5 예를보십시오

 {
  posts : [
    { id : '1' , title : 'a title' , views : 100 } ,
    { id : '2' , title : 'another title' , 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' ,
  } ,
}

JSON5 형식에 대한 자세한 내용은 여기를 참조하십시오.

JSON 서버 CLI로 전달하십시오

$ npx json-server db.json

휴식 API를 받으십시오

$ curl http://localhost:3000/posts/1
{
  " id " : " 1 " ,
  " title " : " a title " ,
  " views " : 100
}

옵션 목록을 위해 json-server --help 실행하십시오

스폰서

스폰서

스폰서

스폰서

스폰서가되어 회사 로고를 여기에 두십시오

스폰서웨어

메모

이 프로젝트는 공정한 소스 라이센스를 사용합니다. 3 명 이상의 사용자가있는 조직만이 스폰서 십 후원자를 통해 소량을 기부해야합니다. 이 라이센스는 프로젝트를 지속 가능하고 건강하게 유지하여 모든 사람에게 도움이됩니다.

자세한 내용, FAQ 및 이의 이론적 근거는 https://fair.io/를 방문하십시오.

경로

예제 db.json 기반으로 다음 경로를 얻을 수 있습니다.

 GET    /posts
GET    /posts/:id
POST   /posts
PUT    /posts/:id
PATCH  /posts/:id
DELETE /posts/:id

# Same for comments

 GET   /profile
PUT   /profile
PATCH /profile

매개 변수

정황

• → ==
• lt → <
• lte → <=
• gt → >
• gte → >=
• ne → !=

 GET /posts?views_gt=9000

범위

• start
• end
• limit

 GET /posts?_start=10&_end=20
GET /posts?_start=10&_limit=10

페이지

• page
• per_page (default = 10)

 GET /posts?_page=1&_per_page=25

종류

• _sort=f1,f2

 GET /posts?_sort=id,-views

중첩 및 배열 필드

• xyz..
• xyz[i]...

 GET /foo?a.b=bar
GET /foo?x.y_lt=100
GET /foo?arr[0]=bar

포함시키다

 GET /posts?_embed=comments
GET /comments?_embed=post

삭제

 DELETE /posts/1
DELETE /posts/1?_dependent=comments

정적 파일을 제공합니다

./public 디렉토리를 작성하면 JSON Server가 REST API 외에 콘텐츠를 제공합니다.

-s/--static 옵션을 사용하여 사용자 정의 디렉토리를 추가 할 수도 있습니다.

json-server -s ./static
json-server -s ./static -s ./node_modules

V0.17의 주목할만한 차이

• id 항상 문자열이며 누락 된 경우 생성됩니다.
• Pagination을 위해 _limit 대신 _page 와 함께 _per_page 사용하십시오
• Chrome의 Network tab > throtling 사용하여 요청을 지연시킵니다 --delay CLI 옵션