为车身参数生成描述字段

Question

所以我一直在谷歌上搜索很多东西来尝试解决这个问题，但我似乎找不到任何关于它的东西。请参阅图片以供参考，但我正在尝试填写主体参数的描述字段。执行此操作的最佳方法是什么？

Answer 1

您可以添加描述属性：

[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

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

首先通过转到区域 -> 帮助页面 -> App_Start -> HelpPageConfig.cs 并取消注释以下两行来打开 XMLDocumentation。

// 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

Right-click 在项目上，单击属性 -> 生成 -> 单击 XML 生成，如图所示。

转到项目中的区域文件夹 -> App_Start -> HelpPageConfig.cs
如果有注释，请取消注释下面的行。

config.SetDocumentationProvider(新的 XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin/projectname.xml")));
将 MapPath 文件名更改为生成 XML 文档文件列中给出的名称。 *projectname 将更改为您的项目名称。

为车身参数生成描述字段

Generate Description Fields for Body Parameters

c#

asp.net

asp.net-mvc-apiexplorer