2013-03-28 12 views
8

投稿アクションは、タイプPersonのFromBodyパラメータを受け取っています。 HelpPageではPersonパラメタに関する情報を取得します。代わりにPersonのプロパティに関する情報を一覧表示し、XMLドキュメントファイルのドキュメントを使用して各プロパティの説明を取得できますか?ASP.Net Web APIヘルプページ:複雑なタイプのプロパティを文書化する

public class PersonController : ApiController 
{ 
    /// <summary> 
    /// Add a person 
    /// </summary> 
    /// <param name="person">Person to add</param> 
    /// <returns></returns> 
    [HttpPost] 
    public HttpResponseMessage Add([FromBody] Person person) 
    { 
     // ... 

     return Request.CreateResponse(HttpStatusCode.Created); 
    } 
} 

/// <summary> 
/// A person 
/// </summary> 
public class Person 
{ 
    /// <summary> 
    /// The name of the person 
    /// </summary> 
    public String Name { get; set; } 

    /// <summary> 
    /// The age of the person 
    /// </summary> 
    public Int32 Age { get; set; } 
} 
+0

現在のところ、この機能はサポートされていません。モデルに使用されているデータ注釈属性のヘルプページの生成を求める関連作業項目があります。あなたのシナリオは修正された後に動作するはずです:http://aspnetwebstack.codeplex.com/workitem/877 –

+0

ありがとう!ここに返信して、私は答えとしてマークします! –

+0

これは '///'コメントで動作するようになりましたか? @KiranChallaにリンクされている作業項目は注釈のサポートを実装しているようですが、Oct 15の時点ではまだヘルプページにドキュメントが表示されていません。 – Mendhak

答えて

6

現在のところ、この機能はサポートされていません。モデルに使用されているデータ注釈属性のヘルプページの生成を求める関連作業項目があります。あなたのシナリオは修正された後に動作するはずです:http://aspnetwebstack.codeplex.com/workitem/877

+0

最新のバージョン(MVC5と並んでASP.NET Web API 2.2を使用しています)には、使用されたデータアノテーションを示す生成されたヘルプファイルが含まれています。詳細については、http://www.strathweb.com/2014/01/return-types-action-parameters-and-data-annotations-now-available-in-web-api-2-1-help-page/を参照してください。 – DigitalDan

関連する問題