我正在使用Swashbuckle在我的WebApi项目中启用swagger和swagger-ui。有没有办法在swagger-ui页面中更改控制器的名称?
在下图中,您可以看到swagger-ui页面中显示的两个控制器。这些被命名为他们在C#代码中,但是我想知道是否有方法来改变这里显示的内容?
这主要是因为您可以看到ManagementDashboardWidget
不是用户友好的名称,所以我想将其更改为用户友好型。
我正在使用Swashbuckle在我的WebApi项目中启用swagger和swagger-ui。有没有办法在swagger-ui页面中更改控制器的名称?
在下图中,您可以看到swagger-ui页面中显示的两个控制器。这些被命名为他们在C#代码中,但是我想知道是否有方法来改变这里显示的内容?
这主要是因为您可以看到ManagementDashboardWidget
不是用户友好的名称,所以我想将其更改为用户友好型。
您可以使用该标记。默认情况下,Swashbuckle为每个操作添加一个带有控制器名称的标签。你可以用SwaggerOperationAttribute
覆盖它。例如,下一行替换默认标签,价值观,与标签测试:
public class ValuesController : ApiController
{
[SwaggerOperation(Tags = new[] { "Test" })]
public IHttpActionResult Get()
{
// ...
}
}
的Get
操作将组Test
中放。
如果您希望操作出现在多个组中,您可以添加更多标签。例如:
[SwaggerOperation(Tags = new[] { "Test", "Release1" })]
会把Get
操作组Test
和Release1
。
这正是我想要的......我从来没有在那部分找到很多文档。非常感谢。 – XN16
您是否尝试过使用Swagger的@Api作为您的宁静服务类的注释? – Sampada
@Sampada我不确定如何访问,请你给我多一点信息? – XN16
我很抱歉@API可用于Java中的招摇,而不是swashbuckle的招摇。 – Sampada