Swagger(Asp.Net Core)是否有控制器描述? [英] Does Swagger (Asp.Net Core) have a controller description?

问题描述

我正在构建一个REST服务，它将托管多个控制器(微服务).总体而言，我们将服务称为鲍勃".因此大张旗鼓地显示鲍勃"/鲍勃微服务的集合".然后列出了控制器名称.现在，它仅显示XYZ，ABC等.是否有办法大张旗鼓地显示"XYZ-XYZ API的集合"或类似内容?

I'm building a REST service that will host multiple controllers (microservices). As a whole, lets call the service "Bob". So swagger displays "Bob" / "A collection of Bob Microservices". Then the controller names are listed. Right now, it just shows XYZ, ABC, etc. Is there a way to maybe have swagger show "XYZ - A collection of XYZ APIs" or something of that sort?

好像招摇似地在方法上显示了///，但在控制器上却未显示.

Seems like swagger shows the ///Summary on the methods, but not on the controllers.

推荐答案

有没有办法大张旗鼓地显示"XYZ-XYZ API的集合"

Is there a way to maybe have swagger show "XYZ - A collection of XYZ APIs"

是的.这是最简单的方法之一. Swagger的ASP.NET Core版本利用

Yes. Here is one of the easiest ways. The ASP.NET Core version of Swagger leverages the ApiExplorerSettings attribute. You can set the GroupName.

public class BobController 
{
    [ApiExplorerSettings(GroupName="XYZ - A collection of XYZ APIs")]
    public IActionResult MyAction() 
    {
        ...
    }
}

组名显示在Swagger UI中，该组的操作列为下面的操作.

The group name appears in the Swagger UI with the group's actions listed as operations underneath.

编辑:以下是基于SledgeHammer的评论的想法.

Here is an idea based on SledgeHammer's comment.

Swagger ASP.NET Core使用IApiDescriptionGroupCollectionProvider构建其描述组.我们可以使用默认的ApiDescriptionGroupCollectionProvider来实现自己的灵感，并在Startup.ConfigureServices期间注册我们的提供程序.我们的实现将使 ApiDescriptionGroups() 方法返回与每个动作的控制器关联的GroupName.然后，我们可以将ApiExplorerSettings属性放在每个控制器上，而不是放在每个动作上.

Swagger ASP.NET Core uses an IApiDescriptionGroupCollectionProvider to build its description groups. We could implement our own, using the default ApiDescriptionGroupCollectionProvider for inspiration, and register our provider during Startup.ConfigureServices. Our implementation would make the ApiDescriptionGroups() method return the GroupName associated with each action's controller. Then we could put the ApiExplorerSettings attribute on each controller instead of onto each action.

这篇关于Swagger(Asp.Net Core)是否有控制器描述?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！