[ApiController]
[ApiVersion("1.0")]
[ApiExplorerSettings(IgnoreApi = false, GroupName = "v1")]
[Route("api/Envios/{version:apiVersion}", Name = "Envios", Order = 1)]
[Produces("application/json")]
public class ShippingController
services.AddSwaggerGen(options =>
{
options.SwaggerDoc(version,
new Info
{
Title = name,
Version = version
}
);
options.DocInclusionPredicate((_, api) => !string.IsNullOrWhiteSpace(api.GroupName));
options.TagActionsBy(api => api.GroupName);
});
6条答案
按热度按时间2g32fytz1#
从ASP.NET Core 6开始,您可以在控制器级别使用
TagsAttribute
:或行动水平:
Swagger将根据
Tags
进行分组,并遵守API版本。h43kikqp2#
Swashbuckle第5版支持以下选项(用于调用
AddSwaggerGen()
):这应该与控制器或操作上的以下属性结合使用:
但是,默认情况下,组名用于包含特定文档中的操作。因此,这可能会导致意外结果(取决于您在调用
options.SwaggerDoc(name, ...)
时对文档的命名)。要使其正常工作,您可能需要添加以下内容:
在这里,对于每个操作,name是文档的名称,组名在
api.GroupName
中可用。要在文档中包括操作而不管其组名,只需返回true。ltqd579y3#
你可以使用标记来实现。默认情况下,Swashbuckle会为每个操作添加一个带有控制器名称的标记。你可以用
SwaggerOperationAttribute
覆盖它。例如,下一行用标记Test替换了默认标记Values:Get
操作现在将被放入组Test
中。如果希望操作显示在多个组中,则可以添加更多标记。例如:
会将
Get
作业放入群组Test
和Release1
中。b1zrtrql4#
我尝试使用venerik的答案,但它仍然保留了UI中的原始控制器名称沿着您指定的新标记。我也不喜欢您必须为每个函数添加一个属性,所以我想出了一个解决方案,您只需为控制器添加一个属性。有两个步骤:
在控制器上添加
DisplayNameAttribute
:然后,在Swagger配置中,您可以使用
GroupActionsBy
函数覆盖基本功能,以提取您在该属性中指定的名称:ControllerName()
是在Swagger-Net库中定义的扩展方法。aiqt4smr5#
默认情况下,如果我有一个名为ShippingController的控制器,则swagger生成的UI名称为“Shipping”
我想把我的控制器的名字改成更友好的或者用另一种语言写的。我能找到的最好的办法是用一个SwaggerOperation属性来改变名字,但是这有一个限制,那就是它是一个方法级别的属性,我真的不想在每个方法上都指定这个名字。
所以,我创建了一个约定类来与控制器的Route属性一起使用,我们通常在控制器上使用这个类,然后让swagger使用它作为控制器的名称。你知道在属性上有一个name属性,但是生成的swagger似乎没有使用它。
步骤1:创建此类:
当应用程序启动时,它将运行此命令,如果控制器具有指定的Route属性,我将能够查找该属性,然后使用name属性更改控制器的名称。
第2步:启动。cs:
修改StartUp.cs文件,并在配置服务中,我们需要在约定列表中注册我们的类。请参见以下内容:
第3步:在每个控制器的Route属性中添加名称属性:
现在,当我运行应用程序并生成我的swagger时,您可以看到控制器名称已更改为与route attributes name属性中的文本相同。
vuktfyat6#
如果要在控制器/类级别执行此操作,下面是here中非常有用的摘录
使用控制器上的[ApiExplorer设置(组名=“组”)]
然后在启动中
还要注意
5.0.0-swashbuckle的测试版现在包含了一个TagActionsBy重载,它支持返回一个标记数组。这应该可以简化上面的自定义