はじめに
APIとは
Application Programing Interface の略で
他社のサービス内の情報や機能を使えるようにする仕組み
リクエスト・・・こういう情報が欲しい!(APIを叩く)
レスポンス・・・欲しい情報
Web APIとは
- HTTTP/HTTPSベースで実現するAPI
- Webを介してしようするAPI
REST API
RESTは設計思想のこと
RESTの原則に従って実装されているAPIのこと
REpresentational State Transferの略
REST APIによる6つの制約条件
- クライアントサーバー
- ユーザーインターフェースと処理を分離する
- 階層化システム
- システムを階層に分離する
- コードオンデマンド
- サーバーの更新によりクライアント側は自動でコードダウンロードし、実行する
- 統一インターフェース(情報の取得、更新、作成、削除はHTTPメソッドを利用)
- キャッシュ制御
- クライアントとサーバーの通信回数と量を減らす
- ステートレス(リクエスト間で影響を及ぼさない)
上記制約を守ったAPIをREST APIという
movieをリソースとしたCRUD操作のURI
movieというリソースを対象としたREST APIを考えます.
概要 | URI | HTTP method |
---|---|---|
一覧取得,読み取り | /movies | GET |
特定リソース取得,読み取り | /movies/12345 | GET |
新規リソース作成 | /movies | POST |
更新 | /movies/12345 | PUT |
削除 | /movies/12345 | DELETE |
HTTPメソッドはリソースに対する操作をしめします。
moviesはリソースを示し、movies/12345の数字の部分は特定のmovie(リソース)のidを表しています。