Swagger UI能否暴露Web页面？.NET6相关实现需求咨询

核心结论 #

Swagger UI原生不支持处理Web页面（如MVC控制器、Razor Pages），它的设计目标是为RESTful API生成文档，只会自动扫描带有[ApiController]特性的控制器，普通MVC控制器/页面不会被识别，所以你在.NET6项目中看不到相关内容是正常现象。

针对你的需求的可行方案 #

1. 展示控制器/页面列表供测试 #

• 自定义端点扫描路由元数据：在.NET6中，所有注册的路由（包括MVC动作、Razor Pages）都存储在EndpointDataSource中，可以编写一个接口，通过依赖注入获取EndpointDataSource，遍历所有端点，提取出控制器名称、动作名称、路由模板等信息，返回结构化列表。示例代码片段：

  [ApiController]
  [Route("api/page-docs")]
  public class PageDocsController : ControllerBase
  {
      private readonly EndpointDataSource _endpointDataSource;
  
      public PageDocsController(EndpointDataSource endpointDataSource)
      {
          _endpointDataSource = endpointDataSource;
      }
  
      [HttpGet]
      public IActionResult GetPageRoutes()
      {
          var routes = _endpointDataSource.Endpoints
              .OfType<RouteEndpoint>()
              .Where(e => e.Metadata.GetMetadata<ControllerActionDescriptor>() != null 
                          || e.Metadata.GetMetadata<PageActionDescriptor>() != null)
              .Select(e => new
              {
                  RouteTemplate = e.RoutePattern.RawText,
                  DisplayName = e.DisplayName,
                  HttpMethods = e.Metadata.GetMetadata<IHttpMethodMetadata>()?.HttpMethods
              })
              .ToList();
          return Ok(routes);
      }
  }
  

• 基于反射扫描：直接扫描程序集，找出所有继承Controller的类和PageModel的类，提取它们的动作方法和路由信息，生成列表。

2. 排查隐藏/废弃/测试页面 #

• 自定义标记特性：创建[DeprecatedPage]或使用原生[Obsolete]特性，标记需要排查的控制器/动作/页面。在扫描路由时，过滤出带有这些特性的项，单独标记展示。
• 结合路由使用统计：在测试环境中添加日志中间件，记录每个路由的请求次数，长期无请求的路由可列为待排查的废弃页面。

3. 展示页面的请求方法、参数等信息 #

• 扩展路由元数据扫描：在提取路由信息时，进一步获取ControllerActionDescriptor或PageActionDescriptor的详细信息，包括动作方法的参数类型、HTTP请求方法（通过[HttpGet]/[HttpPost]等特性）、绑定的模型属性等，将这些信息整理成类似Swagger的结构化数据，再自行实现简单的UI展示，或者修改Swagger的文档生成逻辑，将这些信息注入到Swagger文档中。

为什么这类需求较少？ #

1. Web页面的测试方式不同：Web页面（MVC/Razor Pages）以前端交互为主，测试人员通常直接通过浏览器访问，或使用Selenium等UI自动化工具，很少需要像API那样依赖文档工具来测试参数和请求方法。
2. API与页面的设计目标差异：API是无状态的服务接口，参数、请求方法是核心功能点，需要明确的文档；而页面更多是面向用户的交互载体，其功能和路由通常在产品需求文档或前端文档中体现，专门的文档工具价值有限。
3. 生态工具的定位：现有生态中的文档工具（如Swagger、OpenAPI）都是围绕API设计的，没有针对Web页面的标准化需求，自然相关工具和方案较少。

内容的提问来源于stack exchange，提问作者cheny