Warm tip: This article is reproduced from serverfault.com, please click

c#-有没有办法在swagger-ui页面中更改控制器的名称?

(c# - Is there a way change the Controller's name in the swagger-ui page?)

发布于 2016-05-06 15:29:14

我正在使用Swashbuckle在WebApi项目中启用swagger和swagger-ui。

在下图中,你可以看到swagger-ui页面中显示的两个控制器。它们的名称与C#代码中的名称相同,但是我想知道是否有一种方法可以更改此处显示的内容?

主要是因为你看到ManagementDashboardWidget的不是用户友好名称,所以我想将其更改为用户友好。

swagger-ui

Questioner
XN16
Viewed
11
venerik 2016-05-09 20:06:15

你可以为此使用标签。默认情况下,Swashbuckle将带有控制器名称的标签添加到每个操作中。你可以使用来覆盖它SwaggerOperationAttribute例如,下一行用标签Test替换默认标签Values:

public class ValuesController : ApiController
{
    [SwaggerOperation(Tags = new[] { "Test" })]
    public IHttpActionResult Get()
    {
        // ...
    }
}

Get现在将把操作放入组中Test

如果你希望该操作显示在多个组中,则可以添加更多标签。例如:

[SwaggerOperation(Tags = new[] { "Test", "Release1" })]

会将Get操作分组TestRelease1