我使用rails 4作为restFUL API,并希望像使用php一样使用http://apidocjs.com/。 我可以在/ doc中生成我的api文档,但在我想知道什么是最好的" rails方式"路由到这个文档。我应该创建一个控制器或只是路由到我的html文件,如:
get '/doc', :to => redirect('/doc/index.html')
我尝试了但是我得到了
No route matches [GET] "/doc/index.html"
那么最好的方法是什么?我觉得我不会想到" rails way" ..
答案 0 :(得分:1)
如果您的文档是完全生成的,只是静态html,您只需将其放在public
文件夹中,它就会自动路由。换句话说,您可以在docs
文件夹中创建public
文件夹,然后通过
http://example.com/docs/index.html
在开发中,这将是
http://localhost:3000/docs/index.html
如果你正在寻找更强大的东西,我强烈推荐思想机器人high_voltage。
答案 1 :(得分:0)
如果您将控制器命名为docs并将其命名为index,则可以尝试这样做。
get 'docs', :to => 'docs#index', :as => 'doc'
答案 2 :(得分:0)
resource :doc, only: :show
然后创建此文件
/app/views/docs/show.html
无需控制器
网址为
/doc