如何在ASP.NET Core Web API中集成ASP.NET Help Page文档

你安装包后没有生成对应目录的本质原因是：Microsoft.AspNet.WebApi.HelpPage 是仅适配 .NET Framework 平台下传统 ASP.NET Web API 2 的NuGet包，和ASP.NET Core的运行时、项目结构、API探测逻辑完全不兼容，不存在自动生成Areas/HelpPage目录的可能，和你使用的Visual Studio 2019版本没有关系。

你可以根据自己的维护成本预期，二选一实现和传统ASP.NET HelpPage样式一致的API文档：

• 方案1：直接迁移传统HelpPage的完整代码到Core项目
  1. 临时新建一个.NET Framework版本的ASP.NET Web API 2项目，安装Microsoft.AspNet.WebApi.HelpPage包，等待自动生成完整的Areas/HelpPage目录（包含控制器、Razor视图、模型类、样式脚本资源）
  2. 将生成的HelpPage目录整体拷贝到你的ASP.NET Core项目的Areas目录下，调整命名空间匹配你自己的项目
  3. 在项目路由配置中添加Area路由支持，示例配置如下：

     app.MapControllerRoute(
         name: "areas",
         pattern: "{area:exists}/{controller=Help}/{action=Index}/{id?}");
     

  4. 改写原HelpPage的数据读取逻辑：删除原代码中依赖System.Web、GlobalConfiguration的部分，直接注入ASP.NET Core内置的IApiDescriptionGroupCollectionProvider服务获取所有接口的路由、请求方式、参数、返回类型信息，你之前配置Swagger时已经开启的XML注释读取逻辑可以直接复用，不需要重复配置。
  5. 将原HelpPage依赖的CSS、JS等静态资源移动到项目wwwroot目录下，修正视图中的资源引用路径，启动项目访问/Help路径就能得到和传统HelpPage外观、交互完全一致的API文档页。
• 方案2：自定义Swagger UI样式对齐HelpPage效果
  如果你不想迁移大量旧代码，可以直接基于已经接入的Swashbuckle组件改造UI：
  1. 提取传统HelpPage的样式文件和页面布局结构，替换Swagger UI默认的CSS、页面模板，调整布局为传统HelpPage的左侧接口导航、右侧接口详情的结构
  2. 配置UseSwaggerUI中间件时，指定加载你自定义的静态UI资源，关闭默认的Swagger UI资源引用即可。这个方案维护成本更低，还能保留Swagger自带的在线接口调试、Schema展示等能力。

注意：不要尝试在ASP.NET Core项目中强行引入Microsoft.AspNet.WebApi.HelpPage的程序集，该包依赖的System.Web等核心组件在.NET Core/.NET 5+版本中不存在，强行安装只会引发大量依赖冲突，导致项目无法正常编译运行。

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