如何让 WebApi HelpPage 识别位于 WebApi 项目本身之外的模型文档

How to make WebApi HelpPage recognize model documentations located outside the WebApi project itself

假设我在一个解决方案中有两个项目

对于每个 WebApi 请求,它使用 ModelState 检查模型是否有效,然后将请求传递给核心库中定义的业务模型以获得结果。

我想要自动 API 文档,所以我将 WebApi 项目配置为生成 XML 文档,并且 HelpPage 模块完全符合预期,模型除外在 Core.dll 中定义,留空。

我想知道是否有任何解决方法可以使 HelpPage 模块 "recognize" XML 文档在 WebApi 项目之外?

对于每个包含文档的外部库,您可以设置一个 post 构建事件,将本地生成的 xml 文件复制到中央 "documentation" 文件夹。这显然要求每个生成 xml 文档的项目都对文件进行唯一命名。

您的网络 api 项目然后可以 运行 一个 post 构建事件来将它需要的任何 xml 文件从中央共享库复制到它自己的项目文件夹中。然后,您需要调整 xml 文档提供程序以查找多个 xml 文件,如 post

所示

How can Xml Documentation for Web Api include documentation from beyond the main project?