JSON-Serverを使用して偽のREST APIを起動して実行します

このチュートリアルでは、JSON-Serverを使用して偽のREST APIサーバーのセットアップと使用を開始する方法を確認します。これは、モバイルまたはWebアプリケーションの開発中に使用できます。このチュートリアルでは、JSONとHTTPリクエストの基本的な知識があることを前提としています。

休息とは？

RESTは、表現状態転送を表しています。これは、接続されたアプリケーションを設計するためのアーキテクチャスタイルです。単純なHTTPを使用して、マシン間の通信を可能にします。したがって、一部のユーザー情報を操作するためにURLを使用する代わりに、RESTは、データを操作するためにget、post、削除などのHTTPリクエストをURLに送信します。

たとえば、 /deleteuser?id=10にget requestを作成する代わりに、リクエストはDELETE /user/10のようなものになります。

なぜ偽のREST APIが必要なのですか？

REST APIは、モバイルアプリケーションとWebアプリケーションのバックエンドを形成します。アプリケーションを開発する場合、開発目的で使用できるREST APIを使用することができない場合があります。モバイルまたはWebアプリが動作しているのを見るには、いくつかのダミーJSONデータをスローするサーバーが必要です。

それは、偽のREST APIが写真に登場するときです。 json-server最小限の労力で偽のREST APIサーバーを設定する機能を提供します。

はじめる

json-server使用を開始するには、ノードパッケージマネージャー（NPM）を使用してパッケージをインストールします。

 NPMインストール-G JSON -Server<br>

要件に従って、データを使用してダミーJSONファイルを作成します。たとえば、ID、名前、場所などなどのユーザー情報info.json含むJSONデータが必要です。

 {<br> 「ユーザー」：[{<br> 「id」：1、<br> 「名前」：「ロイ」、<br> 「場所」：「インド」<br> }、{<br> 「id」：2、<br> 「名前」：「サム」、<br> 「場所」：「ウェールズ」<br> }]<br> }<br>

端末から、jsonサーバーをデータソースとしてinfo.jsonで実行すると、http：// localhost：3000で残りのAPIを実行する必要があります。

 JSON-Server Info.json<br>

REST APIエンドポイントをテストします

偽のREST APIサーバーは稼働しているため、クライアントを使用してREST APIにアクセスする方法を見てみましょう。 Postman Restクライアントを使用してAPI呼び出しを行います。

リクエストを取得します

まず、REST URLにGETリクエストを行うことから始めましょう。 JSONファイル内で、ユーザーに関連する情報を含むエンドポイントusersを定義しました。 url http：// localhost：3000/usersにGET requestを作成すると、既存のデータを表示する必要があります。

リクエストを投稿します

既存のデータに新しいデータを追加するために、URL http：// localhost：3000/usersにPOSTリクエストを行います。これがPOSTリクエストがどのように見えるかです：

GETリクエストを実行してみてください。新しく追加されたデータがinfo.jsonファイルにある必要があります。

 [<br> {<br> 「id」：1、<br> 「名前」：「ロイ」、<br> 「場所」：「インド」<br> }、<br> {<br> 「id」：2、<br> 「名前」：「サム」、<br> 「場所」：「ウェールズ」<br> }、<br> {<br> 「名前」：「II」、<br> 「場所」：「LA」、<br> 「ID」：7<br> }、<br> {<br> 「名前」：「ショナ」、<br> 「場所」：「LA」、<br> 「ID」：8<br> }、<br> {<br> 「名前」：「ショナ」、<br> 「場所」：「LA」、<br> 「ID」：9<br> }<br> ]<br>

リクエストを削除します

json-serverデータからエントリを削除するには、ユーザーIDを使用してAPIエンドポイントにDELETE要求を送信する必要があります。たとえば、ID 1でユーザーを削除するには、エンドポイントhttp：// localhost：3000/users/1にDELETE要求を送信する必要があります。削除されたら、 GETリクエストを実行してみてください。ID1のユーザーが返されたJSONに登場しないでください。

パッチリクエスト

既存のエントリを更新するには、その特定のエントリに対して更新する必要がある詳細を記載したPATCHリクエストを送信する必要があります。たとえば、ID 2のユーザーの詳細を更新するために、図のようにhttp：// localhost：3000/users/2にPATCHリクエストを送信します。

JSON-Server REST APIの検索

json-server Rest APIを使用して、データを検索して、特定の基準に基づいてデータを見つけることができます。たとえば、特定の名前を持つユーザーを見つけるには、図のようにREST API URLにGETリクエストを送信する必要があります。

上記の画像に見られるように、urlにget requestを送信しますhttp：// localhost：3000/users？name = shonaは、 Shonaという名前でユーザーを返します。同様に、他のフィールドを持つユーザーを検索するには、そのフィールドをクエリ文字列に追加する必要があります。

REST APIエンドポイントで全文検索を実行するには、パラメーターqとともに検索文字列をエンドポイントに追加する必要があります。たとえば、検索文字sを含む情報を使用してユーザーを検索するために、リクエストは次のようになります。

ページネーションの取り扱い

ページングされたデータグリッドを表示している間、ページネーションに基づいていくつかのデータを取得する必要があります。このようなシナリオでは、 json-server JSONデータをページングする機能を提供します。デフォルトでは、 json-serverから返されたデータの数は10です。_limit _limitを使用してこの制限を明示的に定義できます。

 http：// localhost：3000/users？_limit = 5<br>

上記のURLへのGETリクエストは、5つのレコードを返します。ここで、データをページングするには、URLに別のパラメーター_pageを追加する必要があります。 _pageデータの返却時にフェッチする必要があるページを定義します。

 http：// localhost：3000/users？_limit = 5＆_page = 2<br>

上記のURLへのGETリクエストは、ページごとに5つのレコードがあるデータセットの2番目のページを返します。 _page変数を変更することにより、必要なページレコードを取得できます。

ソートを処理します

json-server取得したデータをソートする機能を提供します。ソートする必要がある列名と、データをソートする必要がある順序を提供することにより、データを並べ替えることができます。デフォルトでは、データは昇順でソートされます。キーワード_sortを使用してエンドポイントURLに列名を提供し、キーワード_orderを使用して順序を定義できます。これがURLの例です。

 http：// localhost：3000/users？_sort = id＆_order = desc<br>

上記のURLは、列Idに基づいてデータをソートし、降順でソートされます。

処理オペレーター

json-server 2つの値の範囲のIDを持つエントリを見つけるなど、特定の正規表現と一致するエントリのエントリを見つけるなど、オペレーターをサポートする機能を提供します。

特定の範囲内のエントリを見つけるために、 _gteおよび_lte演算子を利用できます。たとえば、IDが3を超えて5未満のユーザーを見つけるには、url http：// localhost：3000/users？id_gte = 3＆id_lte = 5にhttp：// localhostにget requestを作成します。

特定の文字から始まる名前を検索したい場合は、正規表現を使用できます。たとえば、文字saで始まる名前を検索するには、 _like演算子を使用して、url http：// localhost：3000/users？name_like =^saにGET requestを作成します。

結論

このチュートリアルでは、 json-server REST APIを使用してダミーデータベースを作成する方法を迅速に使用する方法がわかりました。 json-server使用を開始する方法を学び、URLをクエリしてデータを追加、更新、変更、削除しました。ダミーデータをページング、ソート、および検索する方法を見ました。また、オペレーターを使用して正規表現を使用してエントリを検索する方法も見ました。

ダミーデータ作成にjson-serverまたはその他の偽のREST APIサーバーを使用しましたか？あなたの経験はどうでしたか？ Envatoフォーラムであなたの考えを教えてください。

以上がJSON-Serverを使用して偽のREST APIを起動して実行しますの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。