ASP.Net Core 因集成WebSocket导致Swagger UI显示错误

文章目录

前言
一、ApiExplorerSettings
二、解决Swagger UI显示问题

前言

Swagger UI 本身并不支持直接展示或测试 WebSocket 端点。Swagger（现在称为 OpenAPI）及其 UI 实现主要是为 RESTful API 设计的，这些 API 基于 HTTP 请求/响应模型。WebSocket 是一种不同的协议，它提供了客户端和服务器之间的全双工通信渠道，并不遵循 HTTP 请求/响应模型。

一、ApiExplorerSettings

在 ASP.NET Core 中，ApiExplorerSettings 属性通常用于控制 API 探索过程中特定控制器、动作或参数的可见性。ApiExplorer 是 ASP.NET Core 的一部分，它允许开发者通过反射来发现和分析应用程序中可用的 API 端点。这对于自动生成文档（如 Swagger/OpenAPI 文档）特别有用。

ApiExplorerSettings 属性可以应用于控制器类、动作方法或参数上，以控制它们是否应被 ApiExplorer 发现。这对于隐藏内部 API、调试用的端点或那些你不希望暴露给最终用户的端点特别有用。

使用场景

隐藏整个控制器：如果你有一个控制器，它只用于内部目的，不希望在 Swagger UI 或其他 API文档工具中显示，你可以在该控制器类上使用 ApiExplorerSettings 属性，并将其 IgnoreApi 属性设置为 true。
隐藏特定动作：类似地，如果你只想隐藏控制器中的某个特定动作，你可以在该动作方法上使用 ApiExplorerSettings 属性。
为特定参数设置描述：虽然 ApiExplorerSettings 本身不直接用于设置参数的描述（这通常通过 Swagger 的属性如[SwaggerParameter(Description = “…”)] 来完成），但了解如何通过 ApiExplorer 控制API 的可见性对于理解如何管理你的 API 文档很重要。