2017-08-25 14 views
2

この質問は繰り返されるかもしれないと思うかもしれませんが、私の質問には役に立たない回答が見つかりませんでした。Asp.Net Web APIのResponseTypeAttributeの主な用途は何ですか

これは私のコントローラのアクション

[HttpPost] 
[ResponseType(typeof(UserInputModel))] 
public IHttpActionResult GetUsers(UserInputModel userModel) 
{   
    if(adminBao.GetUsers(userModel)==null) 
    { 
     return NotFound(); 
    } 
    return Ok(adminBao.GetUsers(userModel)); 
} 

それは私が[ResponseType(typeof(UserInputModel))]

を削除するとき、私はこれが一般的な戻り値の型についてのウェブAPIをヒントに使用され知っている出力でどのような違いを生むんです...しかし、それが応答にどのような影響を与えますか?

は、いくつかのいずれかが、私はこの

答えて

1

について理解する助けてくださいすることができますが、それは応答してどのような影響を与えますか?

実際の応答には何の影響もありません。これは主に文書化のためのものです。

主な目的は、アクション定義で抽象化が使用されたときにアクションが返すタイプを知るようにすることです。

エクスプローラは、HttpResponseMessageまたはIHttpActionResultまたはその派生物の1つを特定できません。

こうすることで、ドキュメントを生成するときに適切なタイプを表示できます。

ResponseTypeAttribute Class

宣言された戻り値の型がHttpResponseMessageまたはIHttpActionResultあるときにアクションによって返されたエンティティタイプを指定するために使用します。 ApiDescriptionを生成する場合、 ResponseTypeはApiExplorerによって読み取られます。

関連する問題