REST APIとは？
Googleで「犬」と入力し、検索しますと、「犬」の結果のリストが表示されます。 「犬」のキーワードをリクエストしますと、サーバーは「犬」の結果で応答します。 これは、REST APIとは何かを説明する簡単な方法です。
各URLはRequestであり、返送されるデータはResponseと呼ばれます。
API
Application Programming Interface APIは、プログラムが相互に通信できるようにするルールです。 開発者は、クライアントが通信できるサーバー上にAPIを作成します。
REST
Representational State Transfer APIを作成するときに開発者が従わなければならないルールです。
Requests
Requestは下記の4つの要素で構成されます。
- Endpoint
- Method
- Header
- Data (Body)
Endpoint
エンドポイントは、APIとクライアント間の相互作用のポイントです。 RequestするURLです。 構造は下記のようになります。
root-endpoint/?
Root-endpointはAPIの開始ポイントです。 例えば、GithubのAPIはhttps://api.github.com
パスは、リソースが実際にどこにあるかを決定します。
例えば： https://www.incloud.jp/products/athena
https://www.incloud.jp はRoot-endpointであり、/ products / athenaはリソースです 。
Method
サーバーに送信できるRequestには5つのタイプがあります。
- GET
- POST
- PUT
- PATCH
- DELETE
これらのMethodは、4つの可能な要求アクションを実行するために使用されます：Create, Read, Update, and Delete.
|
Method名 |
Request詳細 |
|
GET |
サーバーからリソースを取得するために使用されます。 クライアントが「GET」requestを実行すると、サーバーは要求されたデータを探してクライアントに送り返します。 「GET」 requestは「READ」操作を実行します。 これはデフォルトのリクエスト方法です。 |
|
POST |
サーバー上に新しいリソースを作成するために使用されます。 クライアントが「POST」 requestを実行すると、サーバーはデータベースに新しいエントリを作成し、成功したかどうかを通知します。 「POST」 requestは「CREATE」操作を実行します。 |
|
PUTとPATCH |
サーバー上のリソースを更新するために使用されます。 「PUT」または「PATCH」要求は、「UPDATE」操作を実行します。 |
|
DELETE |
サーバーからリソースを削除するために使用します。 「DELETE」requestは「DELETE」操作を実行し、サーバーはデータベース内のエントリを削除して、削除が成功したかどうかを通知します。 |
Header
Headerは、クライアントとサーバーの両方に情報を提供するために使用されます。 認証や本文の内容に関する情報の提供など、さまざまな目的に使用できます。
Data (Body)
Data（Body）には、サーバーに送信する情報が含まれています。 Dataは、「POST」、「PUT」、「PATCH」、または「DELETE」リクエストでのみ使用できます。
Conclusion
RESTAPIの基本的な説明であり、サーバーとクライアントの間でオブジェクトの状態を交換することを意味します。 成功するウェブアプリケーションを構築するには、REST APIを理解することが必要です。 クラウドとクライアント間で情報をスムーズに交換できるようにInCloudがREST APIを正しく開発致します。