ruby-on-rails – Rails API版本控制,路由问题

2019年7月27日 180次阅读

我正在尝试使用基于
Railscasts #350 episode的版本控制来实现一个简单的rails api应用程序.我希望通过以下格式的Accept标头提供版本来访问应用程序的特定API版本：application / vnd.rails5_api_test.v1.当没有提供Accept标头时,请求将被路由到应用程序的当前默认版本.为了解决这个问题,我在lib目录中创建了一个api_constraints文件,该文件在路由中是必需的.

我创建了app v1和v2的两个版本,其中v1具有Users资源,v2具有Users和Comments资源.
一切都按预期工作,除了我通过使用Postman通过标题传递版本1来请求URL localhost：3000 / comments时,我从评论资源获得响应,显示所有注释.但我希望响应成为状态：404 Not Found,因为评论资源是版本2,请求的版本是1.

这是来自服务器的响应：

Started GET "/comments" for 127.0.0.1 at 2016-04-01 20:57:53 +0530
Processing by Api::V2::CommentsController#index as application/vnd.rails5_api_test.v1
  Comment Load (0.6ms)  SELECT "comments".* FROM "comments"
[active_model_serializers]   User Load (0.9ms)  SELECT  "users".* FROM "users" WHERE "users"."id" = $1 LIMIT $2  [["id", 1], ["LIMIT", 1]]
[active_model_serializers] Rendered ActiveModel::Serializer::CollectionSerializer with ActiveModelSerializers::Adapter::JsonApi (4.32ms)
Completed 200 OK in 7ms (Views: 5.0ms | ActiveRecord: 1.5ms)

这是我的工作文件：
约束文件lib / api_constraints.rb：

class APIConstraints
  def initialize(options)
    @version = options[:version]
    @default = options[:default]
  end

  def matches?(req)
    req.headers["Accept"].include?(media_type) || @default
  end

  private

  def media_type
    "application/vnd.rails5_api_test.v#{@version}"
  end
end

路由文件,config / routes.rb：

Rails.application.routes.draw do
  require "api_constraints"

  scope module: 'api/v1', constraints: APIConstraints.new(version: 1) do
    resources :users
  end

  scope module: 'api/v2', constraints: APIConstraints.new(version: 2, default: true) do
    resources :users
    resources :comments
  end
end

v1,api / v1 / users_controller.rb的用户控制器：

class Api::V1::UsersController < ApplicationController

  def index
    @users = User.all

    render json: @users, each_serializer: ::V1::UserSerializer
  end
end

用户控制器为v2,api / v2 / users_controller.rb：

class Api::V2::UsersController < Api::V1::UsersController

  def index
    @users = User.all

    render json: @users, each_serializer: ::V2::UserSerializer
  end

end

用于v2,api / v2 / comments_controller.rb的注释控制器：

class Api::V2::CommentsController < ApplicationController

  def index
    @comments = Comment.all

    render json: @comments, each_serializer: ::V2::CommentSerializer
  end
end

v1的user serializer,user_serializer.rb：

class V1::UserSerializer < ActiveModel::Serializer
  attributes :id, :name, :email
end

v2的user serializer,user_serializer.rb：

class V2::UserSerializer < V1::UserSerializer

  has_many :comments
end

注释v2的序列化程序,comment_serializer.rb：

class V2::CommentSerializer < ActiveModel::Serializer
  attributes :id, :description

  belongs_to :user
end

我尝试删除路由中的default：true选项,然后它按预期工作.但我希望它与默认选项一起使用.

任何人都可以让我知道我在哪里弄错了,并分享你对这种方法的看法.如果这不是最好的方法,那么引导我完成实现它的正确方法.提前感谢任何需要时间帮助我的人. :)干杯！

最佳答案 我不认为这可以轻易解决,因为v1没有评论v2将匹配,无论如何.

你是APIConstraints使用这种方法吗？

  def matches?(req)
    @default || req.headers['Accept'].include?("application/vnd.example.v#{@version}")
  end

我认为这里的方法有点过于松散,看起来应该忽略那些有版本的请求.

  def matches?(req)
    (@default &&
         req.headers['Accept'].grep(/^application/vnd.example.v\d+/$).empty?
    ) || req.headers['Accept'].include?("application/vnd.example.v#{@version}")
  end
点赞