Warning: file_get_contents(/data/phpspider/zhask/data//catemap/9/ruby-on-rails-3/4.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Ruby on rails 如何为Rails 3 REST服务生成公共文档?_Ruby On Rails_Ruby On Rails 3_Rest_Documentation_Routes - Fatal编程技术网

Ruby on rails 如何为Rails 3 REST服务生成公共文档?

Ruby on rails 如何为Rails 3 REST服务生成公共文档?,ruby-on-rails,ruby-on-rails-3,rest,documentation,routes,Ruby On Rails,Ruby On Rails 3,Rest,Documentation,Routes,因此,我正在Rails3中使用Desive作为身份验证机制构建一个应用程序。我所有的控制器和视图都正常工作。我们的网站正在蓬勃发展。现在我们想将我们的路线导出给第三方开发者。问题是怎么做 这是我想我需要弄清楚的事情清单 第三方身份验证。我正试着把我需要做的事情弄清楚。我们有一个现有的用户群,并且已经使用Desive身份验证模型为所有用户生成了令牌。现在我需要提供某种安全措施。我目前的思路是建立一个OAuth提供商来管理私钥,然后以某种方式将我们的web应用程序设置为第三方开发人员可以访问的应用程

因此,我正在Rails3中使用Desive作为身份验证机制构建一个应用程序。我所有的控制器和视图都正常工作。我们的网站正在蓬勃发展。现在我们想将我们的路线导出给第三方开发者。问题是怎么做

这是我想我需要弄清楚的事情清单

  • 第三方身份验证。我正试着把我需要做的事情弄清楚。我们有一个现有的用户群,并且已经使用Desive身份验证模型为所有用户生成了令牌。现在我需要提供某种安全措施。我目前的思路是建立一个OAuth提供商来管理私钥,然后以某种方式将我们的web应用程序设置为第三方开发人员可以访问的应用程序之一。这是正确的思路还是我设计过度了

  • 为我们的REST端点生成面向公众的文档。虽然rake路由对于内部开发人员来说很好,但我真的认为我们需要更多类似于swagger ui的东西。问题是rails没有为swagger ui生成适当的json/xml调用。据我所知,这是真正的REST服务所必需的。例如资源列表和资源上的操作列表


  • 提前感谢您在这些竞技场中为我提供的任何指导

    如果您的用户有安全元素,我肯定会推荐OAuth。也就是说,您希望有人能够通过他们的服务编辑多个用户的详细信息,然后使用三条腿的OAuth(提供者、用户、客户端)。否则,选择两条腿的OAuth(提供者、客户端)

    如果您想实现一个三条腿的OAuth API,那么我编写了一个教程,该教程是可用的。它使用Desive和Oauth2


    至于文档,我甚至会编写自定义文档,而不是依赖工具。Twitter有一个很好的API文档,我用它作为我编写的RESTful API的基础。

    如果您的用户有安全元素,我肯定会推荐OAuth。也就是说,您希望有人能够通过他们的服务编辑多个用户的详细信息,然后使用三条腿的OAuth(提供者、用户、客户端)。否则,选择两条腿的OAuth(提供者、客户端)

    如果您想实现一个三条腿的OAuth API,那么我编写了一个教程,该教程是可用的。它使用Desive和Oauth2


    至于文档,我甚至会编写自定义文档,而不是依赖工具。Twitter有一个非常完善的API,我用它作为我编写的RESTful API的基础。

    我对Swagger有偏见(我在Wordnik工作),并将指出我们将添加ruby服务器支持,以自动生成描述层,就像我们使用Scala一样。

    我对Swagger有偏见(我在Wordnik工作)并将指出,我们将添加ruby服务器支持,以像使用Scala一样自动生成描述层。

    该指南非常有用。有一件事还不清楚,那就是把“oauthenticate:interactive=>false”放在哪里,我试着把它放在我的应用程序控制器中,因为我希望所有的东西都需要oauth,但它无法识别它。我确实希望允许登录或OAuth,因为我的web应用程序将使用登录与API进行对话。如果将interactive设置为true,则应同时允许API和登录访问。我就是这么做的。一切“似乎”都在运转。当我们的QA获得一些免费周期时,我们将进行一些测试。这是我提前完成的一个附带项目-P谢谢加兹勒。我相信你,但如果我们的测试人员发现任何问题,我会让你知道!我在这方面的工作有了进一步的进展。我遇到了一个问题,单元测试正在寻找不存在的yml文件。client_application.yml和两个oauth_*.yml文件。知道这里出了什么问题,为什么没有生成这些文件吗?当然,看看这个,直接从教程中复制<代码>在本测试中,我们将使用夹具,我建议使用工厂进行实际测试。从规范/fixtures中获取4个fixtures文件(我从oauth插件获得了它们,但它们没有包含在生成器中)该指南非常有用。有一件事还不清楚,那就是把“oauthenticate:interactive=>false”放在哪里,我试着把它放在我的应用程序控制器中,因为我希望所有的东西都需要oauth,但它无法识别它。我确实希望允许登录或OAuth,因为我的web应用程序将使用登录与API进行对话。如果将interactive设置为true,则应同时允许API和登录访问。我就是这么做的。一切“似乎”都在运转。当我们的QA获得一些免费周期时,我们将进行一些测试。这是我提前完成的一个附带项目-P谢谢加兹勒。我相信你,但如果我们的测试人员发现任何问题,我会让你知道!我在这方面的工作有了进一步的进展。我遇到了一个问题,单元测试正在寻找不存在的yml文件。client_application.yml和两个oauth_*.yml文件。知道这里出了什么问题,为什么没有生成这些文件吗?当然,看看这个,直接从教程中复制<代码>在本测试中,我们将使用夹具,我建议使用工厂进行实际测试。从spec/fixtures中抓取4个fixtures文件(我从oauth插件获得了它们,但它们没有包含在生成器中)越快发生越好。在我看来,所有真正需要做的是以某种方式生成资源,操作响应和招摇过市ui应该可以工作。还没有看到这方面的任何更新。。。事情进展如何?@Altonymous我正在研究ruby API注释支持。关注twitter上的swagger_doc,了解这方面的最新消息。越快发生越好。在我看来,真正需要做的就是用某种方式生成资源和操作