モデルパラメータ説明XMLCOMMENTS

Question

私はSwashbuckle 5.5.3とXMLCommentsを使用してカスタマイズされたAPIドキュメントを使用しています。私はAPIのドキュメントで編集されていないモデルのプロパティの説明を入れました。

サンプルコード：

/// <summary> 
/// SomeDetails. 
/// </summary> 
/// <param name="Model">SomeDetails.</param> 
/// <param name="Model.UserName">SomeDetails of username.</param> 
/// <param name="Model.OwnerId">SomeDetails.</param> 

それは私が一番上に置くの要約を、示しているが、モデルのプロパティの詳細を表示しません。

Answer 1

SwashBuckle documentationに記載されているように、メソッドのパラメータではなく、のプロパティにパラメータの説明を入れなければなりません。これは、このようなモデルを有することを意味する、あなたのケースで

：

public class Model 
{ 
    /// <summary> 
    /// user Name (e.g. ...) 
    /// </summary> 
    public string UserName { get; set; } 

    /// <summary> 
    /// Id of the owner in context of... 
    /// </summary> 
    public int OwnerId { get; set; } 
}