クイックヒント：JSON-Serverを使用したMock Rest API

バックエンドなしでフロントエンドアプリケーションをすばやくプロトタイプ化できますか？最も基本的なシミュレーションAPIを作成することは、時間がかかり、労働集約的です。 JSON-Serverライブラリは、開発とテストのために複雑なRESTFUL APIを作成するための迅速かつ簡単な方法を提供することにより、この問題を解決します。

このクイックヒントは、JSON-Serverを使用して模擬REST APIを作成する方法を教えてくれます。

キーポイント

• JSON-Serverライブラリを使用して、開発とテストのために複雑なRESTFUL APIを迅速に作成し、開発者がバックエンドなしでアプリケーションのフロントエンドをプロトタイプできるようにします。
• JSON-Serverは、フィルター、論理演算子、ページング、ソートなどの機能を提供します。これは、大量の偽データでフロントエンドをテストするために使用できるモックAPIを作成するのに役立ちます。
• faker.jsモジュールを使用すると、開発者はAPIの模擬データを生成でき、開発とテストプロセスがより効率的かつ実際の状況に近づくことができます。

予防策

APIの使用方法に関する安定した原則と基本的な知識が必要です。

次のツールが必要です

nodejs -json -serverはnodejsに基づいて構築されています。
curl - シミュレートされたサーバーのルーティングをテストするために使用されます。

Windowsユーザー：Curlのダウンロードページには、この記事の例を学ぶために使用できる32ビットおよび64ビットバージョンのCurlバイナリが提供されます。

このチュートリアルでは、Bashのような端末を使用することを前提としています。

インストール

JSON-Serverをインストールするには、ターミナルを開いて入力してください。

これにより、システムにJSON-Serverをグローバルにインストールして、好きなディレクトリからサーバーを起動できるようにします。

$ npm install -g json-server

リソース

RESTFUL APIでは、リソースは、タイプ、関連するデータ、他のリソースとの関係、およびそれを動作させる一連のメソッドを備えたオブジェクトです。たとえば、映画のAPIを作成している場合、映画はリソースです。 APIを使用して、このリソースにCRUD操作を適用できます。

リソースを備えたAPIを作成しましょう。

/moviesリソースを作成

という名前のファイルを作成し、次の名前を追加します。

ファイルを保存した後、次のコマンドでサーバーを起動します。 db.json

それだけです！これで、映画APIがあります。このサーバーから映画を入手したり、映画を削除したり、他の多くのアクションを削除したりできます。

{
  "movies": [
    {"id": 1, "name": "The Godfather", "director":"Francis Ford Coppola", "rating": 9.1},
    {"id": 2, "name": "Casablanca", "director": "Michael Curtiz", "rating": 8.8}
  ]
}

モックAPIをテストするには、curlを使用してHTTPリクエストを作成できます。

$ json-server --watch db.json

これにより、このサーバーにあるすべての映画のリストが返されます。上記の場合、2つの映画が入手できます。次に、ID 1の映画を入手するには、URIの終わりにIDを指定するだけです：

。

映画をサーバーに追加するには、映画の詳細を使用してAPIにPOSTリクエストを送信できます。たとえば、

$ npm install -g json-server

これにより、新しい映画データが返されます。レコードが正常に追加されたかどうかを確認するには、ID 3で映画を入手してみましょう。

{
  "movies": [
    {"id": 1, "name": "The Godfather", "director":"Francis Ford Coppola", "rating": 9.1},
    {"id": 2, "name": "Casablanca", "director": "Michael Curtiz", "rating": 8.8}
  ]
}

同様に、Putや削除などの他のHTTP動詞を使用して、このサーバーのデータにアクセスして変更できます。慣習により、投稿は新しいエンティティを作成するために使用され、既存のエンティティの更新に使用されます。

注：put、post and patch requestsには、

ヘッダーが必要です。 Content-Type: application/json

function

JSON-Serverは、バックエンドで手動で構築する必要があるモックAPIに多くの便利な機能を提供します。これらの機能のいくつかを調べてみましょう：

フィルター

クエリ文字列としてURIに追加することにより、フィルターを適用できます。たとえば、「Casablanca」という映画の詳細を取得したい場合は、リソースURIにGETリクエストを送信し、質問マーク（？）を追加し、次にフィルタリングする属性名とその値を送信できます。

$ json-server --watch db.json

フィルター（＆ '）間に'＆ 'を追加することで、複数のフィルターを組み合わせることもできます。たとえば、上記の例でもIDでフィルタリングしたい場合は、次のことを使用できます。

$ curl -X GET "http://localhost:3000/movies"

オペレーター

また、APIは、フィルタリングを容易にするための論理演算子を提供します。演算子よりも大きいおよびを使用できます。また、応答から値を除外するための

もあります。 _gte たとえば、_lte 9以下の評価を持つすべての映画が必要な場合：_ne

複数の演算子と数値を組み合わせることができることに注意してください。 5〜7の評価ですべての映画を入手するには、次のリクエストを行います。

$ curl -X POST -H "Content-Type: application/json" -d '{
  "id": 3,
  "name": "Inception",
  "director": "Christopher Nolan",
  "rating": 9.0
}' "http://localhost:3000/movies"

ページネーション

$ curl -X GET "http://localhost:3000/movies/3"

現実の世界では、多くのデータを処理します。このデータは、JSON-Server内蔵ページネーションサポート（ページごとに10項目を固定）を使用して、小さなチャンクに簡単にロードできます。 たとえば、ムービーAPIの3ページにアクセスする場合は、getリクエストを送信します。

これはアイテム21-30に戻ります。

並べ替え

$ curl -X GET "http://localhost:3000/movies?name=Casablanca"

プロパティとプロパティを使用して、APIからソートされたデータを要求できます。たとえば、映画リストを名前で下降順にソートしたい場合（アルファベット順）、次のリクエストを送信します。

json-serverは他の多くの機能を提供します。 JSON-Serverドキュメントで、これらと上記の機能について詳しく知ることができます。

_sort_orderAPIのシミュレーションデータを生成します

$ curl -X GET "http://localhost:3000/movies?name=Casablanca&id=2"

APIでデータをほとんど使用してフロントエンドをテストするのは楽しいことではありません。 faker.jsなどのモジュールを使用して、モックAPIのサンプルデータを作成できます。

次のコマンドを使用してパッケージをインストールします

と呼ばれるファイルを作成し、次のように入力してください。

ここでは、Fakerを使用して映画のタイトルと監督名を生成する1000の異なる偽の映画エントリを作成しました。スコアは、1〜100の間の乱数を生成し、10で割ることによって作成されます。

このスクリプトを使用して

ファイルを作成するには、端末で次のコマンドを実行します。 db.json

これで、1000枚の映画のデータベースがあります。これで、アプリケーションの開発やテストに使用できる多くの偽データがあります。

$ npm install -g json-server

結論

独自のモックAPIをすばやく作成し、テストデータを追加できるようになりました。 JSON-Serverライブラリを使用すると、フロントエンドを作成することなく、フロントエンドコードを迅速にプロトタイプ化できます。

このツールはワークフローの一部になりますか？または、それをうまく使用する他の方法はありますか？以下のコメントであなたの考えや提案を共有してください！

JSONサーバーを使用してREST APIをシミュレートすることについて、

FAQ（FAQS）

JSONサーバーを使用してREST APIをシミュレートすることの主な利点は何ですか？

JSONサーバーは、開発とテストの目的で偽のREST APIをセットアップするためのシンプルで高速な方法を提供します。これにより、開発者は数分でCRUD（作成、読み取り、更新、削除）操作を使用して完全なREST APIを作成できます。これにより、バックエンドチームが実際のAPIを開発するのを待つ必要性を排除するため、開発プロセスを大幅に高速化できます。さらに、JSONサーバーはJSONファイルを使用してデータを保存し、APIのデータと構造を簡単に変更できます。

JSONサーバーのインストール方法は？

JSONサーバーはnode.jsモジュールであるため、システムにnode.jsとnpm（ノードパッケージマネージャー）をインストールする必要があります。 node.jsとnpmをインストールした後、端末またはコマンドプロンプトの次のコマンドを使用して、システムにJSONサーバーをグローバルにインストールできます。

JSONサーバーを使用して模擬APIを作成する方法は？

npm install -g json-server

JSONサーバーを使用して模擬APIを作成するには、最初にデータベースとして機能するJSONファイルを作成する必要があります。このファイルには、api

を介して提供する番号が含まれている必要があります （スペースの制限のため、後続のFAQコンテンツは省略されます。必要に応じて、具体的な質問をしてください。））

以上がクイックヒント：JSON-Serverを使用したMock Rest APIの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。