asp.net-web-api - ASP.Net Web API帮助页面区域返回空输出

标签 asp.net-web-api documentation documentation-generation

我有一个预先存在的MVC应用程序,我使用Nuget添加了Web API和Web API自我文档。虽然Web API Controller 可以正常运行(将有效响应返回给HTTP请求),但Help Controller 找不到任何要记录的Web API方法。

在帮助 Controller 的索引操作中,“Configuration.Services.GetApiExplorer()。ApiDescriptions”返回的结果为0。

什么填充了ApiDescriptions,我需要进行任何配置设置才能将api公开给文档吗?

帮助区域是与我的应用程序其余部分分开的区域。这是否会导致找到 Controller 的零件找不到我的 Controller ?此外,我什至在HelpController本身中添加了一个帮助,但仍然没有任何API描述。

我的API Controller 也有特殊的路由,所以我不确定这是否相关。

最佳答案

经过更多搜索后,我发现this post也指this post

如第一篇文章中所述,Glimpse是罪魁祸首,此解决方法为我解决了这个问题:

<glimpse defaultRuntimePolicy="On" endpointBaseUri="~/Glimpse.axd">
<inspectors>
   <ignoredTypes>
      <add type="Glimpse.AspNet.Inspector.RoutesInspector, Glimpse.AspNet"/>
   </ignoredTypes>
</inspectors>
</glimpse>

这也是一个已知问题,此Glimpse GitHub Issue中描述了解决方法。

关于asp.net-web-api - ASP.Net Web API帮助页面区域返回空输出,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/19413786/

相关文章:

python - 我是否应该记录函数的所有参数、异常和返回值,即使它们已经记录在其他函数中? (Python)

documentation - Doxygen Javadoc样式的标记描述跨越多行

c# - 最新的 C# 规范在哪里?

documentation - Symfony2 的简单示例

大纲

javascript - 在 javascript 中更新 vscode 注释

c# - Cookie 不会保存在 ASP.NET WebMethod 中

c# - 有条件地忽略属性序列化

c# - 使用 .net 核心 Web API 验证 .net 控制台应用程序

c# - ASP.NET Web API 有条件地返回 HttpResponseMessage