node.jsとexpressで最初のAPIをコーディングします：REST APIを理解する

休憩と安らかなAPIの紹介

現代のWeb開発では、RESTやAPIなどの用語に遭遇することがよくあります。これらの用語を聞いたり、APIを使用したりしているが、それらがどのように機能したり、独自のAPIを構築する方法を完全に理解していない場合は、このチュートリアルシリーズはあなたにぴったりです。

このチュートリアルシリーズは、最初に休憩の原則と概念の概要です。次に、node.js Expressサーバーで実行され、MySQLデータベースに接続する完全なAPIを作成します。この一連のチュートリアルを完了したら、自信を持って独自のAPIを構築したり、既存のAPIのドキュメントを掘り下げたりできるはずです。

前提条件

このチュートリアルを最大限に活用するには、基本的なコマンドラインの知識、基本的なJavaScriptの知識を持ち、node.jsをグローバルにインストールする必要があります。

休息と安らかなAPIとは何ですか？

宣言状態転送（ REST ）は、Webサービスのアーキテクチャスタイルを説明しています。 RESTには、RESTを実装するシステム間でデータを共有するための一連の標準または制約が含まれています。 RESTは、言語、フレームワーク、またはソフトウェアタイプではなく、抽象的な概念です。

休息についてのゆるい類似性は、ビニールレコードコレクションを維持し、ストリーミング音楽サービスを使用することです。物理的なビニールレコードコレクションの場合、コピーを共有および配布するために、各レコードを完全にコピーする必要があります。ただし、ストリーミングサービスの場合、同じ音楽は、曲のタイトルなどの特定のデータを参照することで永続的に共有できます。この場合、ストリーミングミュージックは安らかなサービスですが、ビニールレコードのコレクションは非難されていないサービスです。

APIはアプリケーションプログラミングインターフェイスであり、ソフトウェアプログラムが相互に通信できるインターフェイスです。 RESTFUL APIは、 REST原理と制約に従うAPIにすぎません。 Web APIでは、サーバーはURLエンドポイントを介して要求を受信し、通常はJSON形式のデータである応答を返します。

休憩の原則

6つのガイド制約は、RESTアーキテクチャを次のように定義しています。

1. 統合インターフェイス：コンポーネントのインターフェイスは同じでなければなりません。これは、URI標準を使用してリソース、つまりブラウザのアドレスバーに入力できるパスを特定することを意味します。
2. クライアントサーバー：サーバー（データを保存および操作）とクライアント（リクエストと表示の応答）との間に懸念が分離されています。
3. ステートレスインタラクション：各リクエストに関するすべての情報は、個々のリクエストに含まれており、セッション状態に依存しません。
4. キャッシュ可能：クライアントとサーバーはリソースをキャッシュできます。
5. 階層システム：クライアントは、最終サーバー、またはロードバランサーなどの中間層に接続できます。
6. オンデマンドコード（オプション） ：クライアントはコードをダウンロードして、外部の可視性を低下させることができます。

リクエストと応答

https（安全版）から始まるすべてのWebサイトのURLに既に精通している可能性があります。 HyperText Transfer Protocol（ HTTP ）は、インターネット上のクライアントとサーバー間の通信方法です。

ブラウザのURLバーで最も明らかに表示されますが、HTTPを使用してサーバーからWebサイトをリクエストするだけではありません。 Web上のURLにアクセスすると、実際にGETおよび他の種類のリクエストを実行しています。

HTTPは、サーバーポート（HTTP、HTTPS）へのTCP （輸送制御プロトコル）接続を開くことでリクエストを行い、リスニングサーバーがステータスとボディを返します。

リクエストには、URL、メソッド、ヘッダー情報、および本文が含まれている必要があります。

リクエスト方法

HTTP動詞とも呼ばれる4つの主要なHTTPメソッドがあり、一般的にWeb APIとの相互作用に使用されます。これらのメソッドは、特定のリソースで実行されるアクションを定義します。

HTTP要求方法は、作成、更新、読み取り、削除を表すCRUDの例にほぼ対応しています。 CRUDはデータベース操作で使用される関数を指しますが、これらの設計原則をRESTFUL APIのHTTP動詞に適用できます。

 <code>curl -i https://www.google.com</code>

Googleのサーバーは以下を返します：

 <code>HTTP/2 200 date: Sun, 21 Aug 2022 19:06:22 GMT expires: -1 cache-control: private, max-age=0 content-type: text/html; charset=ISO-8859-1 ...</code>

200ステータスコードとHTTPのバージョンを見ることができます（これはHTTP/1.1、HTTP/2またはHTTP/3になります）。

この特定のリクエストはWebサイトを返すため、Text/HTMLです。 RESTFUL APIでは、Google（Google.comを含めない）へのCURLリクエストが301の応答を返して、リソースをリダイレクトする必要があることを示す場合があります。

REST APIエンドポイント

サーバーでAPIが作成されると、含むデータにエンドポイントを介してアクセスできます。エンドポイントは、投稿のリクエストを受け入れて処理できるURL、リクエストを削除できます。

API URLは、ルート、パス、およびオプションのクエリ文字列で構成されます。

• rootたとえば、 https：//www.php.cn/link/9EFA87E164995A7743ECA9AD63029FA4のルートには、プロトコル、ドメイン名、およびバージョンが含まれる場合があります。
• パス/ユーザー /5：特定のリソースの唯一の場所。
• Limit = 10などのクエリパラメーター（オプション）は、応答をフィルタリングして10の結果のみを含むように使用されます。

たとえば、ID 5のユーザーを取得するには、 /user /5を使用します。

REST API契約

Restful APIを構築するときに従うべき慣習を次に示します。

• エンドポイントはファイル拡張機能を表示してはなりません。APIはJSONを返す可能性が最も高くなりますが、URLは.JSONで終了してはなりません。
• 動詞の代わりに名詞を使用します。たとえば、ユーザーを追加するには、 /usersのエンドポイントを使用して、 /users /add endpointの代わりにpostリクエストを使用する必要があります。 APIは、同じURLに複数のタイプのリクエストを処理できるように開発する必要があります。
• パスはケースに敏感であり、アンダースコアの代わりに小文字とハイフンを使用する必要があります。たとえば、 /users-listは /users_listよりも好ましいです。

これらの慣習はすべて、従うべき厳格な休息基準がないため、原則を導きます。ただし、これらのガイドラインを使用すると、APIが一貫性があり、馴染みがあり、読みやすくなります。

休息の代替案

RESTは素晴らしいツールですが、場合によっては役立ついくつかの選択肢があります。

石鹸

SOAP（Simple Object Access Protocol）は、1998年に作成されたAPIであり、休憩前に非常に人気がありました。それらにはいくつかの大きな違いがあります。まず、SOAPには、応答形式に非常に厳しい制限があります。第二に、SOAPはJSONの代わりにXMLを使用します。これは、レガシーアプリケーションに役立つかもしれませんが、通常は同等のJSONよりも大きく複雑です。最後に、SOAPはHTTPでうまく機能しますが、SMTPなどのプロトコルもサポートしています。

graphql

GraphQLは、Facebookが作成した新しいAPI形式であり、クライアントが必要なデータをサーバーに正確に通知できるようにすることで、データを取得するために必要なHTTP要求の数を減らすことを目的としています。 URLパスを使用する代わりに、GraphQLにはカスタム構文があり、クライアントが必要とするデータを定義して、クライアントが必要なものを1つのリクエストで取得できます。

GraphQLの素晴らしい紹介については、このGraphQLチュートリアルをご覧ください。

結論は

この記事では、RESTとRESTFUL APIが何であるか、HTTP要求方法と応答コード作業、API URLの構造、および一般的なRESTFUL APIコンベンションを学びます。次のチュートリアルでは、node.jsを使用してExpressサーバーを設定し、独自のAPIを構築することにより、これらすべての理論を実践する方法を学びます。

この記事は更新されており、ジェイコブジャクソンの貢献が含まれています。ジェイコブは、ウェブ開発者、ハイテクライター、フリーランサー、オープンソースの寄稿者です。

以上がnode.jsとexpressで最初のAPIをコーディングします：REST APIを理解するの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。