2016-03-22 1 views
0

スーパーヘルプドキュメントを壊さずに、APIメソッドに(明らかに推奨される)IHttpActionResult戻りタイプを使用する方法はありますか?返信時に私のメソッドから List<T> を返すと、非常に説明的なヘルプドキュメントが得られます。私がIHttpActionResultを返すと、役に立たないヘルプドキュメントが得られます。なぜ私たちにそのようなクールなおもちゃを与えてから、おもちゃを壊すものを使うことを提案しますか?ドキュメントのWebサイトをMSの好みのスタイルと一緒に使用するための素晴らしいリソースがありませんか?WebAPI 2ヘルプドキュメントのWebサイトを壊していない戻りタイプ

答えて

1

HttpResponseMessageまたはIHttpActionResultを使用している場合に期待される返品タイプを指定するアクションメソッドにResponseTypeAttributeを追加することができます。これは、文書を生成するときにApiExplorerによって取得されます。ウェブサイトから

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

あなたは彼らがそれをサポートしたり、質問に含めると、おそらくここに誰かが手をオフに知っているかどうかをチェックすべきドキュメントを生成するために、別のAPIを使用している場合。

+1

ああ、私は*ドキュメントのウェブサイトを使用する方法のための素晴らしいリソースがありませんでした*。私は間違った方向にそれについて行きました、私は実際にサイトを作成するものに掘り込む必要があったときにウェブサイト上のドキュメントを探していた。ありがとうございました! –

関連する問題