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

问题描述

我正在构建一个将托管多个控制器(微服务)的 REST 服务.总的来说，让我们称服务为Bob".所以 swagger 显示Bob"/Bob 微服务的集合".然后列出控制器名称.现在，它只显示 XYZ、ABC 等.有没有办法可以大摇大摆地显示XYZ - XYZ API 的集合"或类似的东西?

似乎 swagger 在方法上显示了///Summary，但在控制器上没有显示.

解决方案

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

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

这是一个基于 SledgeHammer 评论的想法.

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

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.

解决方案

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

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() 
    {
        ...
    }
}

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

Edit: Here is an idea based on SledgeHammer's comment.

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屋！