【问题标题】:WebAPI Help Pages doesn't show all endpoints for OData controllerWebAPI 帮助页面不显示 OData 控制器的所有端点
【发布时间】:2014-02-28 07:12:15
【问题描述】:

我使用 OData 为我的 ASP.NET MVC Web API 添加了帮助页面组件。为了使其正常工作,我必须明确指定 [ApiExplorerSetting(IgnoreAPI = false)]。

但是,它只显示默认的 GET 端点,例如:api/Customers。

但我的 API 也支持 GET by ID 和一些导航属性,例如:api/Customers(id) 和 api/Customers(id)/ContactPerson

有没有办法让帮助页面自动生成这些端点?

谢谢!

【问题讨论】:

    标签: asp.net-web-api odata http-get asp.net-web-api-helppages


    【解决方案1】:

    基于 OData 的控制器确实不支持HelpPage,这就是我们在ODataController 上显式设置[ApiExplorerSetting(IgnoreAPI = true)] 属性的原因。即使您尝试将此设置设为false,也不能保证所有内容(显示所有路线、生成的样本)都会按预期工作,因此我建议不要采用这种方法。

    【讨论】:

    • 感谢您的回答
    • 您能否告诉我获取 OData 文档的最佳方法是什么?任何链接将不胜感激。
    • 第二个。我希望能够为我的 OData 端点生成文档。
    • 即使我也在寻找相同的功能。我们目前正在开发 Odata WebApi 服务。我们需要帮助页面文档与无法理解元数据的 QA 自动化团队共享,他们提供了最基本的细节。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-11-12
    • 2013-06-04
    • 1970-01-01
    • 2014-08-08
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多