REST API

2149 ワード


RESTとは?



Representational State Transferの略として、Webアプリケーションでインタラクティブに使用されるWebアーキテクチャモデルです.
すなわち,リソース交換のWeb上の通信アーキテクチャがあり,汎用的なスタイルを規定している.

APIとは?



アプリケーションプログラミングインターフェースの略で、Google Map API、Kakao Vision APIなどの既存のアプリケーションからデータや使用機能を提供する際に使用されるインターフェースと仕様です.
APIはプログラミング言語、オペレーティングシステムなどで使用される一般的な用語である.従って、REST APIとは、REST原則を適用して設計されたサービスAPIであり、多くのサービスがREST APIを提供している.

REST APIのコア



URIはリソースを表現する必要がある。


-リソース名は動詞ではなく名詞でなければなりません。

/students/1

-リソースはCollectionとDocumentで表現できます。


この場合、Collectionは報復を使用していることに注意してください.
/locations/seoul/schools/3
ただし、locationsはCollection、seoulはDocumentを表します.

このリソースの動作はHTTPの方法で表すべきである.


-GETはリソースを問合せます。(学生リスト照会)

GET /students

-POSTはリソースを生成します。(学生の作成)

POST /students

-PUTはリソースを更新します。(1番学生情報更新)

PUT /students/1

-DELETEはリソースを削除します。(1番学生を削除)

DELETE /students/1

HTTP状態コード


要求に対する応答のステータスコードも明確に返され,設計されたREST APIである.
  • 2 xx:成功関連
  • 3 xx:リダイレクト関係
  • 4 xx:クライアントエラー関連
  • 5 xx:サーバエラー