【问题标题】:Web Api 2 Help Pages & OAuth EndpointWeb Api 2 帮助页面和 OAuth 端点
【发布时间】:2014-02-21 21:29:59
【问题描述】:

我正在通过 VS2013 使用 ASP.net Web API 2 为项目创建私有 API。这一切都运行良好,包括自动帮助功能,除了一件事:

API 使用 OAuth 2.0 资源所有者流程进行保护,我想在帮助中包含“/Token”端点,因为没有它,API 中有一个非常重要的部分完全没有记录。

我看不出有什么方法可以做到这一点,因为 OAuth 功能是通过 OAuthAuthorizationServerProvider 类而不是 ApiController 派生类处理的,因此它永远不会包含在标准文档中。

是否有人知道我可以将自己的文档添加到标准帮助功能中?

【问题讨论】:

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


    【解决方案1】:

    我实际上已经设法找到了一种解决方法,虽然是一个讨厌的方法:因为 OAuth 功能在堆栈中进一步处理,所以您基本上可以在 Controller 中创建一个正常的 Action,它采用符合输入的“自定义”对象实际 OAuth 端点所期望的。它永远不会被调用,因为 OAuth 端点首先处理 URI,但它仍然显示在 API 帮助中。

    【讨论】:

    • 漂亮!软件开发=“新”艺术。 :D
    • 一个很棒的答案
    • 我没有更好的答案,还在研究这个。但是,我觉得这个答案很危险。每当您更新或更改令牌端点(我不经常同意)时,您必须记住更改这个假端点,进入您的项目的开发人员也可能认为端点是真实的而不是假的。
    • @PaulBinder 我同意这不是一个好的解决方案,因此我将其描述为“讨厌的”。
    猜你喜欢
    • 2014-12-27
    • 2013-07-08
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2014-10-11
    • 2016-12-08
    • 2015-11-18
    相关资源
    最近更新 更多