teccon forum

API設計原則

7 min read

API 設計を知る

APIデザインにおける重要な技術やプロトコルには、以下のようなものがあります。

  1. REST: Representational State Transfer（REST）は、分散システムのためのソフトウェアアーキテクチャスタイルです。HTTPプロトコルを使用し、リソース指向のアーキテクチャを提供します。

  2. RPC: Remote Procedure Call（RPC）は、クライアントとサーバ間の通信を行うためのプロトコルです。クライアントがリモートサーバ上でプロシージャを呼び出すことができます。

  3. MQTT: Message Queuing Telemetry Transport（MQTT）は、軽量なメッセージングプロトコルで、IoT（Internet of Things）デバイス間の通信に広く使用されます。LwM2M（Lightweight Machine to Machine）は、特に制約のあるデバイス向けの通信プロトコルです。

  4. SOAP: Simple Object Access Protocol（SOAP）は、XMLベースのメッセージングプロトコルで、Webサービスの相互作用を可能にします。

  5. CRUD: Create, Read, Update, Delete（CRUD）は、データの永続性を管理するための基本的な操作のセットです。これは、データベースやウェブサービスなどのシステムで広く使用されます。

  6. QoEとQoS: Quality of Experience（QoE）は、エンドユーザーがサービスを利用する際の満足度や体験の質を表します。Quality of Service（QoS）は、ネットワークやサービスの性能や信頼性などの品質を示します。

  7. WebRTC: Web Real-Time Communication（WebRTC）は、ブラウザ間やブラウザとサーバ間でリアルタイムの音声、ビデオ、データ通信を実現するためのプロトコルとAPIです。

  8. WebSocket: WebSocketは、双方向通信を提供するインターネットプロトコルであり、ブラウザとサーバ間のリアルタイムの通信を実現します。

RESTの原則

タイトル: REST APIの4原則: ウェブサービス設計の基礎

近年、REST（Representational State Transfer）APIはウェブ開発の中心的な要素として急速に広まっています。この成長の背景には、RESTの4つの基本原則があります。以下では、これらの原則について詳しく説明します。

REST APIの6原則: ウェブサービス設計の基礎

近年、REST（Representational State Transfer）APIはウェブ開発の中心的な要素として急速に広まっています。この成長の背景には、RESTの6つの基本原則があります。以下では、これらの原則について詳しく説明します。

  1. アドレス可能性（Addressability）: REST APIにおいて、リソースは一意のURI（Uniform Resource Identifier）によって識別されます。この原則は、リソースが固有の識別子を持ち、それを通じてアクセス可能であることを意味します。これにより、クライアントはリソースを明示的に特定し、必要に応じて操作することができます。アドレス可能性の原則は、ウェブのハイパーメディア機能の基盤となります。

  2. ステートレス性（Statelessness）: REST APIはステートレスである必要があります。つまり、クライアントのリクエストには十分な情報が含まれており、サーバはそのリクエストだけで十分な情報を処理することができます。サーバはクライアントの前回のリクエストやセッションの状態を保持する必要がないため、スケーラビリティが向上し、クライアントとサーバの間の通信が簡素化されます。

  3. 接続性（Connectivity）: REST APIは、クライアントとサーバの間の接続性を向上させることを重視します。これは、クライアントがリソースにアクセスするために必要な情報が、リソースそのものに含まれていることを意味します。この原則により、クライアントとサーバの間の依存関係が最小限に抑えられ、ネットワーク上の通信が効率化されます。

  4. 統一インターフェース（Uniform Interface）: REST APIは統一されたインターフェースを提供することが求められます。これは、リソースへのアクセス方法が統一され、シンプルで一貫性のある方法で提供されることを意味します。統一されたインターフェースにより、クライアントとサーバの間の相互作用が容易になり、システム全体の拡張性と保守性が向上します。

残りは補助的な概念です。

  1. キャッシュ（Cache）: REST APIは、キャッシュを活用することが重要です。クライアントや中間のキャッシュを利用することで、サーバの負荷を軽減し、応答時間を短縮することができます。これにより、ユーザ体験の向上やネットワークの効率化が実現されます。

  2. 階層システム（Layered System）: REST APIは、階層的なシステムを採用します。これにより、アーキテクチャを階層化することで、システム全体の柔軟性と拡張性が向上します。また、階層的なアーキテクチャは、中間のコンポーネントを追加したり置換えたりすることを容易にします。

  3. オンデマンドのコード（Code-On-Demand）: REST APIは、必要に応じてクライアントに実行可能なコードを提供することができます。これにより、クライアントとサーバの間で動的な機能拡張や実行環境のカスタマイズが可能になります。オンデマンドのコードの提供により、クライアント側での処理の負荷を軽減し、柔軟性を高めることができます。

  4. リソース指向: APIのリソースを一意なURIで表現し、それぞれのリソースに対して適切なHTTPメソッドを使用する。

これらの原則は、REST APIの設計において重要なガイドラインとなります。これらを遵守することで、柔軟性のある、スケーラブルなウェブサービスを構築することができます。

https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm

Graph View