1

我目前正在为我的网站的 API 编写文档。

我不确定编写路线的“最佳”方式。我认为 twitter 做得很好，我想复制他们的 url 结构：

https://dev.twitter.com/docs/api
https://dev.twitter.com/docs/api/1/get/statuses/show/:id
https://dev.twitter.com/docs/api/1/post/statuses/retweet/:id

它会是这样的：

 namespace :docs do
     resources :api do
         # and then... not sure
     end
 end

不确定如何编写这部分的路线：/get/statuses/show/:id。

我应该只创建一个自定义路线吗？

match "/:verb/:resource/:action/:params" => "api#resource"

或者，还有更好的方法？

我最终得到的结果可能会对某人有所帮助:)

Ibarcraft::Application.routes.draw do
    def api_versions; [:v1] end
    def api_verbs; [ :index, :show ] end

    constraints subdomain: "api" do
        scope module: "api", as: "api" do
            versions = api_versions

            versions.each do |version|
                namespace version, defaults: { format: "json" } do

                    # all my routes
                    resources :barcrafts, only: api_verbs do
                        collection do
                            get :search
                        end
                        scope module: "barcraft" do
                            resources :users, only: [:index]
                        end
                    end
                    # and more...

                end
            end

            match 'v:api/*path', to: redirect { |params, request| "/#{versions.last}/#{params[:path]}" + (params[:format] ? ".#{params[:format]}" : "") }
            match '*path', to: redirect { |params, request| "/#{versions.last}/#{params[:path]}" + (params[:format] ? ".#{params[:format]}" : "") }
        end
    end
end
4

1 回答 1

1

是的，您需要自定义路线。

但请注意，该:action键是为控制器的操作名称保留的，最好使用类似:action_name

于 2012-04-05T04:57:37.343 回答