WebAPI ApiExplorer 帮助页面参数 其他信息

本文关键字：参数 其他 信息 ApiExplorer 帮助 WebAPI | 更新日期: 2023-09-27 18:36:02

我正在使用MVC4 WebAPI，有一些问题;

  1. 我们如何定义参数页面[附加信息]的"内容"？
    默认情况下，此声明"在请求正文中定义此参数"？？

  2. 我们如何在参数页面 [样本] 上定义示例数据？
    例如，假设一个字符串值应该是"COME"或"GO"，我怎样才能在帮助页面上说明而不是获取其默认的"字符串"值？

  3. 放置一些约束的正确位置在哪里，例如预期的标头值或 API 将产生的可能的响应/错误，以便它出现在帮助页面上？

WebAPI ApiExplorer 帮助页面参数 其他信息

1） 您可以通过在 XML 标记中指定参数来指定参数的注释。例：

/// <summary>
///     Put your comments about / description of this API call.
/// </summary>
/// <param name="myParameter">
///     Put your comments about / description of this parameter here.
/// </param>
[Route("")]
public HttpResponseMessage Get(int my Parameter)
{
    // Code for your action
}

如果参数是复杂类型，并且需要有关该复杂类型的属性的文档，则已发布版本当前不支持此操作。但是，它适用于夜间构建版本，可在此处找到：https://aspnetwebstack.codeplex.com/wikipage?title=Use%20Nightly%20Builds

2） 您可以按照此处的说明指定自己的示例数据：http://blogs.msdn.com/b/yaohuang1/archive/2012/10/13/asp-net-web-api-help-page-part-2-providing-custom-samples-on-the-help-page.aspx

3）我认为这取决于这是全局的，每个控制器还是每个操作。如果它是全局的，您可以将其放在帮助页面区域中 Index.cshtml 页面上的标题下方，并声明它适用于所有 api 调用。如果是每个控制器或每个操作，我会将其放在该控制器或操作的 XML 摘要中。

相关文章：