聞きたいこと
WebAPIの設計に関して質問です。
現在業務でフロントエンド開発をしているのですが、Webフロントエンドに、バックエンドには必須項目でない値が入力されていない場合に、Web APIのリクエストに該当の項目をパラメーターとして含めないでほしいとアナウンスが有りました。
具体的な例でいうと、ユーザ登録画面で
- Email(email)
- パスワード(password)
- 性別(gender)
の3項目を入力する事ができるとします。
もし仮に3つすべて入力されていた場合は、下のようにリクエストを送信します。
{ email: 'hoge@example.com', password: 'password', gender: 'man' }
ただ、性別項目自体はバックエンドとして必須でないため、性別が未入力の場合は以下のようにリクエストを送信してくれと言われました。
{ email: 'hoge@example.com', password: 'password' }
個人的に、性別が未入力の場合、パラメーター自体を削除するのではなく、下のように空にして送信するのがオーソドックスかなと思っていますが、このようなWeb APIの設計は一般的なのでしょうか。
{ email: 'hoge@example.com', password: 'password', gender: '' }
もしアナウンスされた方法が一般的でない場合(Badな場合)、この方法が一般的でないことを説明している文献など紹介していただけたら嬉しいです。
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。
2020/04/15 05:36 編集
2020/04/15 05:35