Question

人：

我用swagger制作api文件。我使用ASP.NET WebAPI2来开发WebAPI。我遇到了三个问题：

首先：我如何为WebAPI控制器添加注释？我尝试在Controller上添加Comment

namespace IMCAPI.Controllers
{
/// <summary>
/// Value API
/// </summary>
[Authorize]
public class ValuesController : ApiController
{
    // GET api/values
    /// <summary>
    /// Get all Values
    /// </summary>
    /// <returns></returns>
    public IEnumerable<string> Get()
    {
        return new string[] { "value1", "value2" };
    }

，但是not work。

第二：我如何通过浏览器Url在Swagger中搜索特定的WebAPI？像这样Browser Url Search

例如，如果我想搜索Value API，我在红色部分输入Value，我希望搜索结果只显示Value API，我不希望出现其他API（如Account）。或者如何设置可以具有搜索功能的SwaggerConfig.c？

第三：我想知道swagger是否只能读取一个xml文件？我在网上搜索，他们这样演示

    private static string GetXmlCommentsPath()
    {
        return String.Format("{0}/App_Data/IMCAPI.XML", AppDomain.CurrentDomain.BaseDirectory);
    }

如果我有多个XML文件，我怎么能在swagger中集成？

它。希望有人可以帮助我。谢谢！

Answer 1

您的第一个问题：评论正在出现，您已将它们放在代码中的Get方法上，它们会出现在{{1}上屏幕截图中的方法。如果您想要的是对整个服务的描述，Swagger documentation说要使用Get方法。

您的第二个：您无法显示该API上的所有方法。

第三：Swagger documentation表示您使用每个XML的路径多次调用Description。

如何在Swagger中实现搜索功能和添加注释

1 个答案: