2017-05-06 14 views
0

最近私は、アプリケーションのWeb APIを設計し始めました。私はthis bookに多くの良いヒントを見つけましたが、回答内容についての質問への回答は見つかりません。さんがモデル WebAPI GETはIDまたは値を返す必要があります

class Foo 
{ 
    public int Id {get;set;} 
    public string Name {get;set;} 
    public int BarId {get;set;} 
} 

class Bar 
{ 
    public int Id {get;set;} 
    public string Name {get;set;} 
} 

次私が持っていると言う

すると、ユーザの要求がfooがBarIdによってBarモデルからBarIdまたはNameを返さなければならないWEBAPI取得するために作りますか?

ので、おそらくそれはIDと値の両方を返すべき

{ 
    "id":1, 
    "name":"foo", 
    "barId":100 
} 

又は

{ 
    "id":1, 
    "name":"foo", 
    "barName":"bar" 
} 

なければならない結果?どんな提案も感謝します。

+1

この質問は**主に意見をベースに送信されるように

がベター**、barIdとbarnameの両方を送信します。多くの良い質問は、専門家の経験に基づいてある程度の意見を生成しますが、この質問に対する回答は、事実、参考文献、または特定の専門知識ではなく、概ね意見に基づいている傾向があります。 – Nkosi

+0

一般的なプラクティスは、情報の全体がレイアウトされたUIを持っていない限り、Fooのみを送信することです。それ以外の場合は、情報をできるだけ小さくすることで、ネットワークスループットとUI応答が向上します。ユーザーが残りの情報が必要な特定のアクションを実行した場合、Ajax呼び出しを使用してフェッチできます。 – Gururaj

答えて

1

UIに応じて、表示する内容が異なります。すべての情報は、そのAPI

{ 
    "id":1, 
    "name":"foo", 
    "barId":2, 
    "barName":"bar" 
} 
関連する問題