Question

我有一个简单的webapi2项目。

我似乎发现自己的唯一信息是指较旧的webapi1

如果我有

，请从我的控制器

   /// <summary>
    /// Gets a list of not very interesting information
    /// </summary>
    /// <returns>The list</returns>
   [ResponseType(typeof(ExampleModel))]
    public IHttpActionResult Get()
    {
        var data = new List<ExampleModel>()
        {
            new ExampleModel()
            {
                Date = DateTime.Now,
                Name = "Tom"
            },
            new ExampleModel()
            {
                Date = DateTime.Now.AddDays(-20),
                Name = "Bob"
            }
        };

当我尝试浏览帮助页面时，为什么没有信息出现。我被告知没有可用的文件。

是否有某个神奇的开关可以打开这些数据的自动填充？

Answer 1

如果你提到显示xml评论，那么你可以在这里找到我的答案：

ASP.NET Web API Help Page documentation using Xml comments on controllers

请务必在Regions / HelpPage / App_Start / 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文件进入App_Data而不是bin，它在项目属性中默认为

在WebApi2帮助页面中启用文档

1 个答案: