Motting API サーバーURL設計 - MasatoTokuse/motting Wiki

URL設計

Motting API サーバーのURL構築の基本方針を決める。

基本ルール

メソッドの種類

取得:GET

追加:POST

一部を更新:PUT, PATCH

削除:DELETE

安全メソッド:

冪等性:何度実行しても結果が同じ。何度実行してもシステムのリソースが同じ状態であること

PUTの例:

・Githubのスター、Twitterのいいね ON/OFFの切り替え

URL例:

名言を取得する

GET  http://motting/api/v1/witticism/4

名言を追加する

POST http://motting/api/v1/witticism

名言を更新する

PUT http://motting/api/v1/witticism/4

(名言の発言者を更新する)

PATCH http://motting/api/v1/witticism/4/tellername

(名言を公開する)

PATCH http://motting/api/v1/witticism/4/publish

名言を削除する

DELETE http://motting/api/v1/witticism/4