XMLCOMMENTS中的模型參數描述

我正在使用Swashbuckle 5.5.3和使用XMLComments定製的API文檔。我已經提供了未在API文檔中編輯過的模型屬性的描述。XMLCOMMENTS中的模型參數描述

示例代碼：

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

它顯示了總結，我放到了首位，但不顯示模型屬性的細節。

來源

2016-11-24 Uzair Xlade

你有什麼行動PARAMS？在截圖中，我看到兩個參數：userName和ownerId，而我沒有看到任何你描述的「Model」對象。 –

MethodName（[FromUri（Name =「」）] ModelName model）這就是爲什麼你看不到模型。 –

如果您使用模型對象作爲輸入，那麼描述將取自ModelName類的屬性（如UserName，OwnerId等）中提供的文檔 –

如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; } 
}

來源

2016-11-25 07:55:00 bsoulier

XMLCOMMENTS中的模型參數描述

回答

相關問題