[英]How to display parameter in Web API help page documentation for Response only?
[英]How to display parameter in Web API help page for request and response body
我想將請求和響應主體顯示為參數而不是原始數據。 為此,我遵循了 Generate Description Fields for Body Parameters 的答案,但沒有成功,仍然顯示
/// <summary>
/// Gets some very important data from the server.
/// </summary>
/// <param name="reqData">A Test Model</param>
[HttpPost]
public AccountService.GetAccountList_ResponseData GetAccountList([FromBody] AccountService.GetAccountList_ReqestData reqData)
{
}
//--my modal
public class GetAccountList_ReqestData
{
/// <summary>
/// StartDate
/// </summary>
/// <param name="StartDate">Describe parameter.</param>
public string StartDate { get; set; }
}
//---Also enabled
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/WebApi.xml")));
您必須將 XmlDocs 添加到您的 class GetAccountList_RequestData
/// <summary>
/// My requestData model
/// </summary>
/// <param name="reqData">The description you want </param>
public class GetAccountList_ReqestData
{
/// <summary>
/// StartDate
/// </summary>
/// <param name="StartDate">Describe parameter.</param>
public string StartDate { get; set; }
}
您正確地遵循了這些步驟,但是在另一個線程中詢問的人正在顯示一個屬性。 另一方面,您要求的是 object,這是您的 class。因此,class 的 xmldoc 將用於生成描述。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.