API設計に関するまとめ

概要

API設計初心者ですので、いろいろ調べて見る。自分用まとめ。

用語

LSUDs = Large Set of Unknown Developers(不特定多数のユーザーに提供するAPI)
SSKDs = Small Set of Unknown Developers(特定のシステムのみで利用する専用のAPI)
HATEOS = Hypermedia As The Engine Of Application State(リソース同士に関連性のあるAPIのこと)

APIリクエスト(POST/PUT)のcontent-type

application/x-www-form-urlencoded

body部分にkey-value形式で送信したいデータを格納する。

application/json(より主流)

body部分にJSON形式で送信したいデータを格納する。

APIレスポンスのcontent-typeとフォーマット

application/json(JSON-RPC)

参考

application/hal+json(HAL)

参考

application/vnd.api+json(JSON API)

参考

application/vnd.collection+json(Collection JSON)

参考

参考

REST API のコツ
Web APIにはJSONベースのフォーマットを使おう