如何为客户端开发人员列出rails app的所有api

时间:2015-01-28 04:26:08

标签: ruby-on-rails api rest

我正在学习和开发rails,仅提供RESTful apis。但我需要一些方法列出所有api,以便客户端应用程序开发人员可以查看它们,并可能使用列表页面测试它们。像asp.net这样的东西提供。是否有任何gem可以列出所有API及其所需的输入参数。我认为它可能与路径文件有关,但我想不出多少。

3 个答案:

答案 0 :(得分:0)

可用于此类目的的文档工具很少,您可以探索yardoc的工作原理。

答案 1 :(得分:0)

您可以使用api-pie gem。它将是API文档非常有用的宝石。

答案 2 :(得分:0)

我认为从路线获取所有api将是一个好方法。 以下是如何获取应用的所有路线(来自rake routes任务)

all_routes = Rails.application.routes.routes
require 'action_dispatch/routing/inspector'
inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
puts inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, ENV['CONTROLLER'])