WebAPI帮助页-读取控制器属性

本文关键字:控制器 属性 读取 帮助 WebAPI | 更新日期: 2023-09-27 18:22:12

我正在使用nuget的WebAPI帮助页面项目来记录我的ASP.Net WebAPI服务。

我有几个控制器具有[授权]属性和几个自定义属性。

我没有能够实现的是将属性添加到文档中。

因此,如果控制器被标记为[授权],那么控制器的文档会说类似于"此XYZ控制器需要授权"

因此,我的问题是如何修改WebAPI帮助代码,以记录控制器上的属性。

模型级别的属性正在正常工作。

WebAPI帮助页-读取控制器属性

您可以为此修改Areas'HelpPage'上安装的XmlDocumentationProvider.cs。对GetDocumentation(HttpControllerDescriptor controllerDescriptor)方法进行了修改。您可以检查未使用控制器类型controllerDescriptor.ControllerType修饰的任何属性,并相应地更改文档。

升级HelpPage nuget包时,您可能会发现执行上述操作不方便,因为您可能希望用最新的位覆盖内容。。。因此,您可以创建一个继承自XmlDocumentationProvider的自定义文档提供程序,并对已安装的HelpPageConfig.c文件进行小的修改,然后向您的自定义提供程序提及。