クライアントでAPIから返されたプロパティを指定する

Question

私は、REST APIのdotnet coreで返されるプロパティの量を制限したいと考えています。リソースにアクセスするとき、クライアントはAPIから返されたデータの特定のサブセットのみを必要とします。クライアントが返したいプロパティをAPIに伝える良い方法は何ですか？

私の最初の考えは、このようなエンドポイントにクエリパラメータを追加することです：

http://www.restapi.com/v1/resource?fields=id,name,type

しかし、私はそれを再利用可能ときれいになるように、APIでこれを実装するための最良の方法を確認していません。

Answer 1

ウェブAPIを使用して完全なドメインモデルやデータモデルを返すことは通常ありません。通常は、この目的のためにカスタムモデルタイプを定義します。必要に応じて、モデルバインドやモデル検証の属性で装飾することもできます。

あなたは、クライアントはそれを取得どのような性質を決定することができるようにしたい場合は、この目的のために構築された匿名型を返すか、おそらくいくつかのDTOのタイプは、クライアントのパラメータがにつながることを事前に定義することができます。