0

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

  • WebApi:一个WebApi项目,为所有api服务提供接入点
  • Core:此处定义业务逻辑的库项目,包括系统模型。

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

我想拥有自动 API 文档,因此我将 WebApi 项目配置为生成 XML 文档,HelpPage 模块按预期完美运行,除了在 Core.dll 中定义的模型时,它是空白的。

我想知道是否有任何解决方法可以使 HelpPage 模块“识别”WebApi 项目之外的 XML 文档?

4

1 回答 1

1

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

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

Web Api 的 Xml 文档如何包含主项目之外的文档?

于 2015-04-15T13:39:30.477 回答