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

REST 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 （デフォルト= 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サーバーはREST APIに加えてコンテンツを提供します。

-s/--staticオプションを使用してカスタムディレクトリを追加することもできます。

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

v0.17の顕著な違い

• id常に文字列であり、欠落している場合に生成されます
• ページネーションのために_limitの代わりに_pageで_per_page使用します
• ChromeのNetwork tab > throtlingを使用して、 --delayオプションの代わりにリクエストを遅らせる