ホームページ ウェブフロントエンド jsチュートリアル REST API を理解する - せっかちな人のためのガイド

REST API を理解する - せっかちな人のためのガイド

Nov 11, 2024 am 01:17 AM

私の記事のクロスポストはこちら

REST (ReプレゼンテーションState Ttransfer) API は、現代の Web 開発のバックボーンです。この記事では、最新の REST API を作成および使用する方法、作成時に考慮すべき設計上の決定事項、および REST の基礎となる理論について詳しく説明します。

実践ガイド

このセクションでは、エンドポイント、メソッド、リクエスト、レスポンスをカバーする HTTP での REST API の使用について詳しく説明します。 API 呼び出しを開始し、プロジェクトに REST を適用するために必要なものがすべて見つかります。

URI を構造化する方法

一般に、URI を扱うには主に 2 つの方法があります。

  1. アクションとして
  2. リソースとして

次の 2 つの URI について考えてみましょう:

  1. https://example.com/getUserData?id=1 (アクション)
  2. https://example.com/users/1 (リソース)

どちらの例も、ID が 1 のユーザーのユーザー データを取得することを示しています。違いは、最初の例ではルート /getUserData がアクションを実行しているのに対し、2 番目の例ではルート /users/1 が次の場所であることです。アセットではありますが、どのようなアクションが実行されているかは示されません。このタイプの URI は名詞として機能していると言えます (アクション、つまり動詞ではなく物であるため)。

REST パターンでは、2 番目の例のように URI を厳密に使用することが規定されています。 HTTP メソッドを動詞として使用して、それらの名詞に対してアクションを実行できるように、URI を名詞にしたいと考えています。たとえば、HTTP メソッド GET を使用して /users/1 に関する情報を取得できますが、PUT を使用して対応するユーザーの情報を更新したり、DELETE を使用してユーザーを完全に削除したりできます。

URI について最後に注意すべきことは、上記の例と同様、個々のリソース (この場合は単一のユーザーなど) を参照する場合、URI はそのリソースの一意の識別子で終わる必要があるということです。特定のカテゴリ内のすべてのリソースを参照する場合は、一意の識別子を省略する必要があります。

  1. https://example.com/users/1 - ID が 1 の特定のユーザーを参照します
  2. https://example.com/users - ID に関係なくすべてのユーザーを参照します

どのようなアクションをサポートするか

REST でサポートする主なアクションは 4 つあり、それらを覚えるために頭字語 CRUD を使用します: Create、Read、U pdate、Delete。これらの各アクションは、そのアクションを実行するために使用できる HTTP メソッドにマップされます。マッピングは次のとおりです:

Action HTTP Method
Create POST
Read GET
Update PUT / PATCH
Delete DELETE

サポートするすべてのアクション URI の組み合わせ

すべての REST API は、実際には (少なくとも) 5 ~ 6 個のルートにすぎません。この例では、ベース エンドポイントは /users となり、それを https://example.com でホストするふりをします。

  • https://example.com/users を取得します
    • アクション: すべてのユーザー アセットを返します (各アセットは 1 人のユーザーです)
    • リクエスト本文: 空
    • レスポンスボディ: ユーザーアセットのリスト (JSON 配列として)
  • GET https://example.com/users/[id] ([id]は変数)
    • アクション: 要求された単一のユーザー アセットのみを返します
    • リクエスト本文: 空
    • レスポンスボディ: 一致する ID (JSON として) を持つユーザー アセットのみ
  • POST https://example.com/users
    • アクション: 1 つのユーザー アセットをコレクションに追加します
    • リクエスト本文: 新しいユーザーアセットの作成に必要なすべてのデータ(特定の形式は必要ありません。JSON を推奨します)
    • レスポンスボディ: 一意の ID (JSON として) が挿入された新しく作成されたアセット
  • PUT https://example.com/users/[id] ([id]は変数です)
    • アクション: 1 人の既存ユーザーのデータのみを指定されたデータで完全に置き換えます
    • リクエスト本文: 変更されたかどうかに関係なく、既存のユーザーのデータを置き換えるのに必要なすべてのデータ (ID を除く - 特定の形式は必要ありません。JSON を推奨)
    • レスポンスボディ: 一致する ID (JSON として) を持つ新しく更新されたアセット
  • (オプション) PATCH https://example.com/users/[id] ([id]は変数です)
    • アクション: 1 人の既存ユーザーのデータのみを指定されたデータで部分的に置き換えます
    • リクエスト本文: 更新が必要なデータのみ (ID を除く - 特定の形式は不要、JSON を推奨)
    • レスポンスボディ: 一致する ID (JSON として) を持つ新しく更新されたアセット
  • DELETE https://example.com/users/[id] ([id]は変数です)
    • アクション: ユーザー テーブルから 1 つのレコードだけを削除します
    • リクエスト本文: なし
    • レスポンスボディ: なし (HTTP レスポンスコードのみ) OR 一致する ID (JSON として) で削除されたばかりのアセットからのデータ

設計上の考慮事項

REST パターンを使用するかどうかのエンドポイントの定義以外にも、エンドポイントの構築を始める前に考慮すべきことがたくさんあります。将来的にエンドポイントを更新する可能性はありますか?出力はユーザーに役立つヒントを提供する必要がありますか? REST はあなたの状況で使用するのに適切なパターンですか?これらの質問のいくつかに答えてみましょう。

エンドポイントのバージョン管理

将来の変更が容易になるように、最初から API のバージョン管理について検討し始めることをお勧めします。ユーザーが使用する API バージョンを決定するには、いくつかの方法があります。

  • URI のバージョニング
    • バージョン番号は、通常は URL パスのベースに組み込まれます
    • :
    • https://example.com/v1/users/1
    • https://example.com/v2/users/1
  • クエリパラメータ
    • バージョン番号は API エンドポイントのクエリ パラメーターとして追加されます
    • :
    • https://example.com/users/1?apiVersion=1
    • https://example.com/users/1?apiVersion=2
  • ヘッダーベース
    • バージョン番号は特定の一意のヘッダー フィールドです
    • 例 (リクエストヘッダー):
    • x-api-version: 1
    • x-api-version: 2
  • コンテンツの交渉
    • バージョンは、表現状態またはメディア タイプに基づいて決定されます。
    • 以下の例では、サーバー コードは、firstName が最初のバージョンのものであり、次のバージョンでは GivenName に変更されたことを認識します。
    • 例 (リクエスト本文):
    • { 名前: 'ヘンリー' }
    • {与えられた名前: 'ヘンリー' }

クイック REST API のモック化

時々、それをいじってみることが、それらがどのように機能するかを学ぶための最良のツールです。 REST をデモするための私のお気に入りのライブラリの 1 つは json-server です。セットアップは非常に簡単です。必要な手順はほんの数ステップだけです。

JSON サーバーをインストールします

npm install json-server
ログイン後にコピー

単純なデータ ストアを作成する

{
  "users": [
    { "id": "1", "username": "gorwell", "email": "gorwell@gmail.com" },
    { "id": "2", "username": "cdickens", "email": "cdickens@gmail.com" },
    { "id": "3", "username": "jausten", "email": "jausten@gmail.com" },
    { "id": "4", "username": "vwoolf", "email": "vwoolf@gmail.com" },
    { "id": "5", "username": "sking", "email": "sking@gmail.com" }
  ]
}
ログイン後にコピー

サーバーを起動します

npx json-server db.json
ログイン後にコピー

ローカルサーバーに対して HTTP リクエストを作成します

curl -X GET http://localhost:3000/users/1
ログイン後にコピー

簡単な CRUD データ グリッド

完全に機能する REST エンドポイントは、ZingGrid を使用して簡単にデータ グリッドに接続できます。ベース REST URI を に指定するだけです。以下のような要素の src 属性






Understanding REST APIs - A Guide for the Impatient

最終的な考え

REST API はウェブ上でさまざまな形やサイズで提供されており、それぞれが特定のニーズを満たすように調整されています。 URI を慎重に構造化し、適切なアクションを選択し、バージョン管理を念頭に置くことで、開発者が楽しく作業できる簡単で柔軟な API を作成できます。これらの基本的な手順を実行すれば、簡単なプロトタイプであっても、時の試練に耐える堅牢で信頼性の高い API に進化させることができます。

以上がREST API を理解する - せっかちな人のためのガイドの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

Video Face Swap

Video Face Swap

完全無料の AI 顔交換ツールを使用して、あらゆるビデオの顔を簡単に交換できます。

ホットツール

メモ帳++7.3.1

メモ帳++7.3.1

使いやすく無料のコードエディター

SublimeText3 中国語版

SublimeText3 中国語版

中国語版、とても使いやすい

ゼンドスタジオ 13.0.1

ゼンドスタジオ 13.0.1

強力な PHP 統合開発環境

ドリームウィーバー CS6

ドリームウィーバー CS6

ビジュアル Web 開発ツール

SublimeText3 Mac版

SublimeText3 Mac版

神レベルのコード編集ソフト(SublimeText3)

フロントエンドのサーマルペーパーレシートのために文字化けしたコード印刷に遭遇した場合はどうすればよいですか? フロントエンドのサーマルペーパーレシートのために文字化けしたコード印刷に遭遇した場合はどうすればよいですか? Apr 04, 2025 pm 02:42 PM

フロントエンドのサーマルペーパーチケット印刷のためのよくある質問とソリューションフロントエンド開発におけるチケット印刷は、一般的な要件です。しかし、多くの開発者が実装しています...

javascriptの分解:それが何をするのか、なぜそれが重要なのか javascriptの分解:それが何をするのか、なぜそれが重要なのか Apr 09, 2025 am 12:07 AM

JavaScriptは現代のWeb開発の基礎であり、その主な機能には、イベント駆動型のプログラミング、動的コンテンツ生成、非同期プログラミングが含まれます。 1)イベント駆動型プログラミングにより、Webページはユーザー操作に応じて動的に変更できます。 2)動的コンテンツ生成により、条件に応じてページコンテンツを調整できます。 3)非同期プログラミングにより、ユーザーインターフェイスがブロックされないようにします。 JavaScriptは、Webインタラクション、シングルページアプリケーション、サーバー側の開発で広く使用されており、ユーザーエクスペリエンスとクロスプラットフォーム開発の柔軟性を大幅に改善しています。

誰がより多くのPythonまたはJavaScriptを支払われますか? 誰がより多くのPythonまたはJavaScriptを支払われますか? Apr 04, 2025 am 12:09 AM

スキルや業界のニーズに応じて、PythonおよびJavaScript開発者には絶対的な給与はありません。 1. Pythonは、データサイエンスと機械学習でさらに支払われる場合があります。 2。JavaScriptは、フロントエンドとフルスタックの開発に大きな需要があり、その給与もかなりです。 3。影響要因には、経験、地理的位置、会社の規模、特定のスキルが含まれます。

JavaScriptを使用して、同じIDを持つArray要素を1つのオブジェクトにマージする方法は? JavaScriptを使用して、同じIDを持つArray要素を1つのオブジェクトにマージする方法は? Apr 04, 2025 pm 05:09 PM

同じIDを持つ配列要素をJavaScriptの1つのオブジェクトにマージする方法は?データを処理するとき、私たちはしばしば同じIDを持つ必要性に遭遇します...

JavaScriptは学ぶのが難しいですか? JavaScriptは学ぶのが難しいですか? Apr 03, 2025 am 12:20 AM

JavaScriptを学ぶことは難しくありませんが、挑戦的です。 1)変数、データ型、関数などの基本概念を理解します。2)非同期プログラミングをマスターし、イベントループを通じて実装します。 3)DOM操作を使用し、非同期リクエストを処理することを約束します。 4)一般的な間違いを避け、デバッグテクニックを使用します。 5)パフォーマンスを最適化し、ベストプラクティスに従ってください。

Shiseidoの公式Webサイトのように、視差スクロールと要素のアニメーション効果を実現する方法は?
または:
Shiseidoの公式Webサイトのようにスクロールするページを伴うアニメーション効果をどのように実現できますか? Shiseidoの公式Webサイトのように、視差スクロールと要素のアニメーション効果を実現する方法は? または: Shiseidoの公式Webサイトのようにスクロールするページを伴うアニメーション効果をどのように実現できますか? Apr 04, 2025 pm 05:36 PM

この記事の視差スクロールと要素のアニメーション効果の実現に関する議論では、Shiseidoの公式ウェブサイト(https://www.shisido.co.co.jp/sb/wonderland/)と同様の達成方法について説明します。

JavaScriptの進化:現在の傾向と将来の見通し JavaScriptの進化:現在の傾向と将来の見通し Apr 10, 2025 am 09:33 AM

JavaScriptの最新トレンドには、TypeScriptの台頭、最新のフレームワークとライブラリの人気、WebAssemblyの適用が含まれます。将来の見通しは、より強力なタイプシステム、サーバー側のJavaScriptの開発、人工知能と機械学習の拡大、およびIoTおよびEDGEコンピューティングの可能性をカバーしています。

Console.log出力の違い結果:なぜ2つの呼び出しが異なるのですか? Console.log出力の違い結果:なぜ2つの呼び出しが異なるのですか? Apr 04, 2025 pm 05:12 PM

Console.log出力の違いの根本原因に関する詳細な議論。この記事では、Console.log関数の出力結果の違いをコードの一部で分析し、その背後にある理由を説明します。 �...

See all articles