0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

protobuf.devのAPI Best Practicesを読んでいく全部俺Advent Calendar 2024

Day 21

API Best Practices ~【Appendix】繰り返しフィールドを返す

Posted at

【Appendix】繰り返しフィールドを返す

repeated のフィールドが empty の場合、クライアントはそのフィールドが単にサーバによって入力されなかっただけなのか、それともそのフィールドのバッキングデータが本当に空なのかを判断することができません。

これを解決する具体的な方法は、フィールド読み取りマスクを使用することです。
フィールドが要求された場合、空リストはデータがないことを意味します。
フィールドがリクエストされなかった場合、クライアントはレスポンス中のフィールドを無視すべきです。


明示的に欲しいと request したもの以外は見ないし、欲しいといったものは response を信用する。
でも聞いてみたらサーバでミスってたごめんね。の場合は多そうなのでコミュニケーションとれる場合はとっていきたいですね。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?