我正在使用 SwaggerUI 来记录 API 端点。目前,它们按控制器名称分组在一个长列表中。然后,您可以展开每个控制器来查看操作。一切标准。
我想做的是将控制器分组到常见的可扩展组下。
例如,您有一个宠物组,可以将其展开以显示猫和狗控制器,然后可以依次展开以显示它们各自的操作。
我曾尝试使用标签来完成此任务,但我能得到的最好结果是将所有操作分组在一个可扩展组下。
有谁知道标准 swaggerUI 是否可以实现这一点?或者我需要创建自定义 HTML 来完成此任务?
我猜你用的是 Swashbuckle?您需要的是实现 IDocumentFilter。查看标签Swagger 2.0 规范 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md.
来自文档: https://github.com/domaindrivendev/Swashbuckle
文档过滤器
通过连接一个或多个文档过滤器来对整个 Swagger 文档进行后修改。
IDocumentFilter 有以下接口:
void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer);
这可以完全控制修改最终的 SwaggerDocument。您可以从提供的内容中获得更多背景信息SwaggerDocument
(例如版本)和IApiExplorer
。您应该对 Swagger 2.0 规范有很好的了解。在使用此选项之前。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)