Web API帮助页面 - 使用来自其他项目和基类的XML注释

时间:2016-02-22 18:25:11

标签: .net asp.net-web-api

我在我的Web API项目中添加了Help Pages。但是,大多数文档都没有显示在帮助页面上,因为:

  1. 用作参数类型和返回类型的对象是在单独的程序集/项目中定义,并且
  2. 控制器的文档'动作是由控制器实现的单独接口中定义的。此外,这些接口位于单独的程序集/项目中。
  3. 我的解决方案结构概述:

    • Web API项目
    • 包含数据对象的类库(用作控制器操作中的参数类型和返回类型)
    • 带控制器接口的类库(由每个控制器实现)

    帮助页面是否可以a)合并来自不同项目的XML文档,以及b)将XML文档从接口应用到实现它的类?

2 个答案:

答案 0 :(得分:0)

从其他项目.xml文件(在/ bin文件夹中)复制成员集合并粘贴到.xml文件中。

答案 1 :(得分:0)

我解决了这个问题如下:

  1. 为了处理来自多个项目的XML文件,我已合并this answer中的代码。这段代码基本上完成了@lcryder建议但自动执行的操作。
  2. 要将XML文档从接口应用到其实现的类,我使用GhostDoc的文档此选项来复制XML文档。
  3. 但是我对#2不满意,因为它需要手动干预,我必须记得在文档发生变化时重新复制XML文档,所以我仍然在寻找更好的答案。