Open5
[設計] API設計をまじめに考える
あざらしFastAPIでソースを書けば体裁はSwaggerがどうにかしてくれるので、このスクラップではそれ以前のことを考える
たとえば効率～とか、セキュリティ～とか
あざらしURI設計
短くて入力がしやすい
省略しない
大文字と小文字が混ざってない(基本は小文字)
単語はハイフン繋ぎ
単語は複数形を使う
エンコードが必要な文字を使わない
更新がしやすい
ルールが統一されている
こっちも
あざらしログイン時のAPIについて
例えばログイン後にログインユーザーの情報をサーバーから取得したいとき、どちらのほうが一般的か
①IDとパスワードをPOSTして、レスポンス200がかえってきたら再度GETをリクエストしてデータを取得する
②IDとパスワードをPOSTして、レスポンス200と共にそのユーザーに紐づくデータも返信データに含める
自分のかんがえ：「②」の方が無駄なやりとりを1つ減らせるのでは？
ちゃっぴー
んｔｔ
APIを使った開発においてよくあるのがPOST/PUTでデータを更新した時に、最新のデータをGETで取り直すというものです。これは2回APIアクセスする必要があってムダです。POSTで作った、PUTで更新したデータについて、その最新の状態をレスポンスに含めるようにしましょう。
あざらしGETリクエストを送信したときにデータが0件だった場合
①データ0件のまま（空のまま）レスポンス送信するのか？
②「DATA NOTHING」みたいな文字列を送信するのか？
自分の考え：空で十分、データがなかったことはわかるので①かな？
ちゃっぴー：
あざらしバージョン管理をURLに含めるか？
→社内向けシステムなので今回はここまで厳密に管理する必要なさそう？