我目前正在 Rails 中开发 API 端点。如果我需要的数据无效,我想确保端点响应具有正确的错误状态。我需要一个 id 数组。无效值之一是空数组。
{ vendor_district_ids: [2, 4, 5, 6]}
{ vendor_district_ids: []}
所以我想要一个请求规范来控制我的行为。
require 'rails_helper'
RSpec.describe Api::PossibleAppointmentCountsController, type: :request do
let(:api_auth_headers) do
{ 'Authorization' => 'Bearer this_is_a_test' }
end
describe 'POST /api/possible_appointments/counts' do
subject(:post_request) do
post api_my_controller_path,
params: { vendor_district_ids: [] },
headers: api_auth_headers
end
before { post_request }
it { expect(response.status).to eq 400 }
end
end
如您所见,我在
subject
块内的参数中使用了一个空数组。
在我的控制器中,我正在使用
获取数据params.require(:vendor_district_ids)
其值如下
<ActionController::Parameters {"vendor_district_ids"=>[""], "controller"=>"api/my_controller", "action"=>"create"} permitted: false>
vendor_district_ids
的值是一个空字符串数组。当我用postman
发帖时,我没有相同的价值。
如果我发帖
{ "vendor_district_ids": [] }
控制器将收到
<ActionController::Parameters {"vendor_district_ids"=>[], "controller"=>"api/my_controller", "action"=>"create"} permitted: false>
这里的数组是空的。
我在请求规范中做错了什么,还是这是来自
RSpec
的错误?
找到答案了!
问题是在 Rack 的
query_parser
内部发现的,而不是像前面的答案所表明的那样,实际上是在 Rack-test 内部。
"paramName[]="
到{"paramName":[""]}
的实际翻译发生在Rack的query_parser中。
问题示例:
post '/posts', { ids: [] }
{"ids"=>[""]} # By default, Rack::Test will use HTTP form encoding, as per docs: https://github.com/rack/rack-test/blob/master/README.md#examples
将您的参数转换为 JSON,方法是使用
'require 'json'
将 JSON gem 请求到您的应用程序中,并使用 .to_json
附加您的参数哈希值。
并在您的 RSPEC 请求中指定该请求的内容类型为 JSON。
修改上面例子的例子:
post '/posts', { ids: [] }.to_json, { "CONTENT_TYPE" => "application/json" }
{"ids"=>[]} # explicitly sending JSON will work nicely
对于每个想知道的人 - 有一个捷径解决方案:
post '/posts', params: { ids: [] }, as: :json
这实际上是由
rack-test >= 0.7.0
[1] 引起的。
它将空数组转换为
param[]=
,稍后解码为 ['']
。
如果您尝试使用例如运行相同的代码
rack-test 0.6.3
您将看到 vendor_district_ids
根本没有添加到查询中:
# rack-test 0.6.3
Rack::Test::Utils.build_nested_query('a' => [])
# => ""
# rack-test >= 0.7.0
Rack::Test::Utils.build_nested_query('a' => [])
# => "a[]="
Rack::Utils.parse_nested_query('a[]=')
# => {"a"=>[""]}
[1] https://github.com/rack-test/rack-test/commit/ece681de8ffee9d0caff30e9b93f882cc58f14cb
我无法像我的情况一样将其作为 json 发送,因为我还以多部分形式发送文件..我的解决方法是在数组中放入一个空字符串..
post '/posts', params: { ids: [""] }