Rails 文档路径

Question

我使用 rails 4 作为 restFUL API 并且想像使用 php 一样使用 http://apidocjs.com/。 我可以在 /doc 中生成我的 api 文档，但在我想知道路由到该文档的最佳 "rails way" 是什么之后。我应该创建一个控制器还是只路由到我的 html 文件，例如：

get '/doc', :to => redirect('/doc/index.html')

我试过了，但我明白了

No route matches [GET] "/doc/index.html"

那么最好的方法是什么？我觉得我不觉得"rails way"..

Answer 1

如果你有名为 docs 的控制器和名为 index 的操作，你可以这样尝试。

 get 'docs', :to => 'docs#index', :as => 'doc'

Answer 2

resource :doc, only: :show

然后创建这个文件

/app/views/docs/show.html

不需要控制器

URL 将是

/doc

Answer 3

如果您的文档是完全生成的并且只是静态的 html，您只需将它放在 public 文件夹中，它就会自动传送。换句话说，您可以在 public 文件夹中创建 docs 文件夹，然后通过

访问您的页面

http://example.com/docs/index.html

在开发中这将是

http://localhost:3000/docs/index.html

如果您正在寻找更强大的东西，我强烈推荐 Thoughtbot 的 high_voltage。