REST API とは？

• IAM 用語集
• REST API とは？

REST API（Representational State Transfer Application Programming Interface）とは、RESTful API とも呼ばれ、ウェブサービスやモバイルアプリケーションの開発に多用されるウェブベースの API（Application Programming Interface）です。

API とは？

RESTful API の詳細を掘り下げる前に、まず API とは何かを理解する必要があります。

API とは、異なるシステムやアプリケーションが相互に通信できるようにするためのプロトコルやルーチンのセットで、開発者やエンドユーザーがその実装方法を知る必要はありません。API を活用することで、開発者は再利用可能なウェブアプリケーションやソフトウェアアプリケーションを簡単かつ迅速に作成することができます。

API には、さまざまなユースケースに対応するためにさまざまな種類があります。REST API は、ウェブベースの API を構築する上で広く使用されており、現代のウェブ開発において重要な役割を担っています。

REST とは？

REST とは、「Representational State Transfer」を表しています。ウェブサービスを構築するためのアーキテクチャスタイルであり、異なるコンピュータシステムがインターネット上で相互に通信するための標準化された方法を提供します。REST は、特定のテクノロジーやプロトコルではなく、一連の設計原則に基づいており、ウェブベースの API を構築する際に広く使用されています。

REST の主な特徴のひとつとして、GET、POST、PUT、DELETE などの HTTP メソッドを使用して、リソースに対して実行可能なさまざまな操作を表現することがあります。これらのリソースには、ウェブサービスによって公開されているあらゆる種類のデータや機能が使用されている可能性があり、通常は標準化されたデータ形式（通常は JSON）を使用して表現されます。

REST API はステートレスです。つまり、クライアントからの各リクエストには、リクエストを完了する上で必要なすべての情報が含まれており、サーバーはリクエスト間でクライアントのコンテキストを保存することはありません。このため、REST API は柔軟でスケーラブル、かつ簡単にキャッシュできます。

RESTful API の仕組み

RESTful API は、他のすべての API と同様に異なるコンピュータシステムがインターネット上で相互に通信するための標準的な方法を提供することで機能します。具体的には、REST API は、サードパーティのアプリケーションやサービスが標準的な HTTP メソッドを使用してアクセスおよび操作できるリソースを公開します。これらのリソースは、ユーザーデータ、製品情報、検索結果など、API が提供するあらゆる種類のデータまたは機能である可能性があります。

RESTful API でリソースにアクセスするには、クライアントは特定のエンドポイント（リソースを識別する URL）に HTTP リクエストを送信します。通常は、リクエストの種類に応じて、パラメータ、ヘッダー、メッセージボディなどの追加情報がリクエストに含まれます。

サーバーがリクエストを処理し、リクエストが成功すると、HTTP レスポンスをクライアントに送り返します。このレスポンスには通常、リクエストが成功したかどうかを示すステータスコードと、リクエストされたリソースを標準的なフォーマットで含むメッセージボディが含まれます。

REST API はステートレスなため、サーバーはリクエスト間でクライアントの状態を追跡することはありません。個々のクライアントリクエストには、レスポンスを生成する上で必要なすべての情報が含まれています。

REST API のメリット

ウェブサービスやデータ駆動型アプリケーションの構築に RESTful API を使用することには、数多くのメリットがあります：

拡張性： RESTful API はスケーラブルに設計されています。つまり、大量のリクエストを処理でき、トラフィックの急増に対応することができます。また、シンプルで軽量なアーキテクチャを採用しているため、システム全体を再構築することなく、簡単に新しい機能やリソースを追加することができます。

柔軟性： RESTful API は柔軟性が高く、さまざまなプログラミング言語やテクノロジーで使用することができます。特定のプラットフォームや言語に縛られないため、異なる OS やデバイスで動作するクライアントでも利用することができます。

使いやすさ： RESTful API は使いやすく、標準的な HTTP メソッドを使用してアクセス可能なので、あらゆるスキルレベルの開発者がアクセスできます。異なるシステムが互いに通信するための標準的な方法を提供するので、開発時間の短縮、生産性の向上、市場投入までの時間の短縮に貢献します。

ステートレス： RESTful API がステートレスであることは、信頼性が高く、簡単にキャッシュできることを意味し、レイテンシーの低減とパフォーマンスの向上に貢献します。

セキュリティ： RESTful API は、SSL/TLS 暗号化や OAuth 認証など、さまざまな手法でセキュリティを確保することができます。これにより、API が不正なアクセスから保護され、クライアントデータが安全に保たれるようになります。

REST API のベストプラクティス

ここでは、使いやすく、信頼性が高く、安全な RESTful API を、堅牢で適切に構造化し、設計、実装するためのベストプラクティスをいくつかご紹介します。

HTTP メソッドを正しく使用する： HTTP の仕様に従って、適切な HTTP メソッド（GET、POST、PUT、PATCH、DELETE など）を使用して、リソースに対してさまざまな操作を実行します。例えば、リソースを取得するには GET、新しいリソースを作成するには POST、既存のリソースを更新するには PUT、リソースを削除するには DELETE を使用します。

意味のある URL を使用する： URL は、読みやすく理解しやすいものを使用し、アクセスするリソースを明確に示すようにします。覚えにくく、識別しにくい暗号的な URL や意味のない URL は避けてください。

データ形式として JSON を使用する： RESTful API は複数のデータ形式で API リクエストを受け付け、応答することができますが、JSON は API データを送受信する上で事実上の最新標準となっています。これは、XML やプレーンテキストのデコードやエンコードが非常に面倒であり、フレームワークによってはこれらの形式をサポートしないものもあるためです。

エンドポイントの URL には、動詞ではなく名詞を使用する： つまり、https://www.example.com/getPosts や https://www.example.com/createPost ではなく、https://www.example.com/posts を使用します。これは、GET、POST、PUT、PATCH、DELETE などの HTTP メソッドがすでに動詞の形になっているためです。名詞を使うことで、エンドポイントが実際に生成するものを示します。

レスポンスコードに工夫を凝らさない： リクエストの状態を示すために、200（成功）、404（見つからない）、500（サーバーエラー）など、標準的な HTTP レスポンスコードを使用します。これにより、クライアントがリクエストの結果を理解しやすくなり、適切な行動をとることができます。

ドキュメント、ドキュメント、さらにドキュメント： 利用可能なリソース、そのデータ形式、サポートされる操作に関する情報を含む、明確で詳細な API のドキュメントを提供します。これにより、開発者はあなたの API を理解、使用しやすくなります。

バージョニングを実装する： これにより、その API に変更しても、新しいバージョンへ強制的に移行されることで既存のアプリケーションに支障をきたすことがないようにします。

レスポンスボディにエラーの詳細を返す： API が JSON やレスポンスボディで、影響を受けるフィールドを含むエラーの詳細を返すと、開発者は感謝することでしょう。これは、アプリのデバッグに非常に役立ちます。

API の安全性を確保する： SSL/TLS 暗号化、レート制限、クライアント認証制御などのセキュリティ対策を実施し、脅威者が API を操作したり、DDoS 攻撃でオフラインにすることができないようにします。