生成主体参数的描述字段

Question

所以我一直在谷歌搜索试图解决这个问题，但我似乎无法找到任何东西。请参阅图片以供参考，但我试图填写身体参数的描述字段。这样做的最佳方式是什么？

Answer 1

您可以添加Description属性：

[Description("Get the data from our service. It will requires a key.")]
public ActionResult GetData(string key)
{
  //Do something here...
  return Json(new{Success=true, Data = data});
}

或参数

public ActionResult GetData([Description("A valid key should be formated as xxx-xxx-xx")]string key)
{
  //Do something here...
  return Json(new{Success=true, Data = data});
}

来自：http://millionbonus.bitbucket.org/mvc.apiexplorer/

Answer 2

好吧，所以我想出来了，希望这可以帮助遇到这个问题的其他人。您要做的第一件事就是遵循此link为ApiExplorer启用XML文档。启用后，您要添加

/// <summary>Description</summary>

在控制器名称上方（您可以通过添加另一行<param name="model">A Test Model</param>在xml中添加参数名称）

然后前往您的模型，对于模型中的每个参数，再次添加摘要标记，如下所示：

public class TestModel()
{
/// <summary>This is your IdNumber you received earlier</summary>
public string IdNumber {get;set;}
}

Answer 3

我发现这里的答案令人困惑，所以这是我的完整解决方案。

首先转到区域 - ＆gt;打开XMLDocumentation; HelpPage - ＆gt; App_Start - ＆gt; HelpPageConfig.cs并取消注释以下两行。

// Uncomment the following to use the documentation from XML documentation file.
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

然后，为您提供以下格式创建xml注释的文档的方法。这通常是为我自动完成的，但我打开了resharper，因此可能不是默认值。

    /// <summary>
    /// An example method description
    /// </summary>
    /// <param name="id">An example parameter description</param>
    /// <returns>An example return value description</returns>
    // GET: api/Products/5
    public string Get(int id)
    {
        return "value";
    }

如果您运行应用程序并转到api帮助页面，则文档应该可见。

Answer 4

1. 右键单击项目，单击“属性”->“构建”->单击XML构建，如图所示。

1. 转到项目中的Areas文件夹-> App_Start-> HelpPageConfig.cs

2. 如果有注释，请取消注释下面的行。

   config.SetDocumentationProvider（新的XmlDocumentationProvider（HttpContext.Current.Server.MapPath（“〜/ bin / projectname.xml ”））））;

3. 使用“构建XML文档文件”列中指定的名称更改MapPath文件名。 *项目名称将更改为您的项目名称。