REST API まとめ

REST API設計に関してまとめようと思ったけれど，
既に誰かがやっていたのでまとめofまとめになってしまうため，簡単なメモとして残す．

素晴らしいまとめ.

REST APIとはときかれれて，一文で答えるならば，
「EntityやResourceに対してCRUD操作をするAPIです．」

もう少し冗長にいう場合，
「HTTPのPOST, GET, PUT, DELETE メソッドを，EntityやResourceに対してのCRUD操作, Create, Read, Update, Deleteに対応づけたWebAPIです．」

と，RPC over HTTPしか知らない人に説明する．

/${pathto}/api/v${number}/${entities}/${id}?${k0}=${v0}&${k1}=${v1}

とか

/${pathto}/api/v${number}/${entities0}/${id0}/${entities1}/${id1}

Over HTTPなので名前をあまり冗長にしないほうがいい．特にGETパラメータを省略系にして，GETパラメータ以外はちゃんと書くようにする．

上記の超基本設計にむりやり対応させるならば，

idの部分をdetailsとして，app(=entity)に関する情報はdetailsのGETパラメータに含めるようにしている．この例だとidがpkgnameみたいな感じ．

このURL自体というより，このURLに飛ぶとCloudera Managerが提供しているREST API一覧が登場する．

Hadoopが提供するService, 及びそのコンポーネントをうまく整理し，統治しているCloudera様だからできていることだと思う．

WebAPI設計といってもRESTスタイルにこだわらなくてもいい．
Entityに対するCRUD操作という考え方が人間にわかりやすいから採用されやすいだけ．

KZKY memo