c# - Swagger UI 嵌套的可扩展分组

Question

我正在使用 SwaggerUI 来记录 API 端点。目前，它们按 Controller 名称分组在一个长列表中。然后您可以展开每个 Controller 以查看操作。一切标准。

我想做的是将 Controller 分组到通用的可扩展组中。

例如，您有一个可以展开的宠物组，以显示猫和狗 Controller ，然后依次展开它们以显示它们各自的操作。

我曾尝试使用标签来完成此操作，但我能得到的最好结果是将所有操作分组到一个可扩展组中。

有谁知道标准的 swaggerUI 是否可行？还是我需要创建自定义 HTML 才能完成此操作？

Answer 1

我假设您正在使用 Swashbuckle？您需要的是实现 IDocumentFilter。查看 Swagger 2.0 Spec 中的标签.

From the docs:

文档过滤器

通过连接一个或多个文档过滤器对整个 Swagger 文档进行后期修改。

IDocumentFilter 具有以下接口(interface):

void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer);

这样可以完全控制修改最终的 SwaggerDocument。您可以从提供的 SwaggerDocument(例如版本)和 IApiExplorer 中获得额外的上下文。您应该对 Swagger 2.0 规范有很好的理解。在使用此选项之前。