CRUDとHTTPメソッド
あるリソースへのCRUDを実現するのに、
- 誰が(認証情報で表す)[optional]
- 何を(endpointで表す)
- どうする(HTTPmethodで表す)
リスポンスはRESTful APIのHTTPステータスコード設計で行う。誰がを認証情報で表す、に関しては[REST] 認証が必要な API を REST っぽく作るときのメモを参考にする。
実例
- api/users
- GET ユーザ一覧取得
- POST 新規ユーザ作成
- api/users/1
- GET 既存ユーザ１のデータの取得
- PATCH,PUT user1が既存ならば上書き、なければ新規作成(PUTは冪等)
- DELETE user1を削除
認証に関して
こちらによると、現在の主流はBearer tokenを使う方法らしい。
- Basic認証
- Authorization: Basic ABcdeFGhijklMNOpQRSTUvWxYX==
- Digest認証
- Cookie認証
- Cookie: SessionID=abcdefghijklmn; Permission=hoge
- Bearer認証
- Authorization: Bearer ab_cd.EfG-H.IJkL
その他
DB論理設計は、こちらを参照