如何在 Web API 请求和响应主体的帮助页面中显示参数

Question

我想将请求和响应主体显示为参数而不是原始数据。 为此，我遵循了 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")));

Answer 1

您必须将 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 将用于生成描述。