blocks|key|983042|text|您可以像这样解析响应正文：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|983043|parsed_body+=+JSON.parse(response.body)|code-block|syntax|javascript|983044|然后，您可以针对已解析的内容进行断言。|983045|parsed_body["foo"].should+==+"bar"|983046|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|N|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|O|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|P|8|@]|9|@]|A|$E|F]]|$1|K|3|-4|5|6|7|Q|8|@]|9|@]|A|$]]]|L|$]]

You could parse the response body like this:

<pre><code>parsed_body = JSON.parse(response.body)
</code></pre>

Then you can make your assertions against that parsed content.

<pre><code>parsed_body["foo"].should == "bar"
</code></pre>

blocks|key|983097|text|在Kevin+Trowbridge's+answer基础上构建|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|983098|response.header['Content-Type'].should+include+'application/json'|code-block|syntax|javascript|983099|entityMap|0|LINK|mutability|MUTABLE|url|https://stackoverflow.com/a/9789953/111363^0|1|P|0|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@$A|R|B|S|1|T]]|C|$]]|$1|D|3|E|5|F|7|U|8|@]|9|@]|C|$G|H]]|$1|I|3|-4|5|6|7|V|8|@]|9|@]|C|$]]]|J|$K|$5|L|M|N|C|$O|P]]]]

Building off of <a href="https://stackoverflow.com/a/9789953/111363">Kevin Trowbridge's answer</a>

<pre><code>response.header['Content-Type'].should include 'application/json'
</code></pre>

blocks|key|768153|text|简单易用的方法来做到这一点。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|768154|#+set+some+variable+on+success+like+:success+=>+true+in+your+controller
controller.rb
render+:json+=>+{:success+=>+true,+:data+=>+data}+#+on+success

spec_controller.rb
parse_json+=+JSON(response.body)
parse_json["success"].should+==+true|code-block|syntax|javascript|768155|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

Simple and easy to way to do this.

<pre><code># set some variable on success like :success =&gt; true in your controller
controller.rb
render :json =&gt; {:success =&gt; true, :data =&gt; data} # on success

spec_controller.rb
parse_json = JSON(response.body)
parse_json["success"].should == true
</code></pre>

blocks|key|768211|text|还可以在spec/support/中定义帮助器函数|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|768212|module+ApiHelpers
++def+json_body
++++JSON.parse(response.body)
++end
end

RSpec.configure+do+%7Cconfig%7C+
++config.include+ApiHelpers,+type:+:request
end|code-block|syntax|javascript|768213|并在需要访问json_body响应时使用JSON。|768214|例如，在请求规范中，您可以直接使用它|768215|context+'when+the+request+contains+an+authentication+header'+do
++it+'should+return+the+user+info'+do
++++user++=+create(:user)
++++get+URL,+headers:+authenticated_header(user)

++++expect(response).to+have_http_status(:ok)
++++expect(response.content_type).to+eq('application/vnd.api%2Bjson')
++++expect(json_body["data"]["attributes"]["email"]).to+eq(user.email)
++++expect(json_body["data"]["attributes"]["name"]).to+eq(user.name)
++end
end|768216|entityMap^0|4|D|0|0|6|9|0|0|0^^$0|@$1|2|3|4|5|6|7|S|8|@$9|T|A|U|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|V|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|W|8|@$9|X|A|Y|B|C]]|D|@]|E|$]]|$1|M|3|N|5|6|7|Z|8|@]|D|@]|E|$]]|$1|O|3|P|5|H|7|10|8|@]|D|@]|E|$I|J]]|$1|Q|3|-4|5|6|7|11|8|@]|D|@]|E|$]]]|R|$]]

You can also define a helper function inside <code>spec/support/</code>

<pre><code>module ApiHelpers
 def json_body
 JSON.parse(response.body)
 end
end

RSpec.configure do |config| 
 config.include ApiHelpers, type: :request
end
</code></pre>

and use <code>json_body</code> whenever you need to access the JSON response.

For example, inside your request spec you can use it directly

<pre><code>context 'when the request contains an authentication header' do
 it 'should return the user info' do
 user = create(:user)
 get URL, headers: authenticated_header(user)

 expect(response).to have_http_status(:ok)
 expect(response.content_type).to eq('application/vnd.api+json')
 expect(json_body["data"]["attributes"]["email"]).to eq(user.email)
 expect(json_body["data"]["attributes"]["name"]).to eq(user.name)
 end
end
</code></pre>

blocks|key|983197|text|另一种只测试JSON响应(而不是其中的内容包含期望值)的方法是使用ActiveSupport解析响应：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|983198|ActiveSupport::JSON.decode(response.body).should_not+be_nil|code-block|syntax|javascript|983199|如果响应不是可解析的JSON，将抛出异常，测试将失败。|983200|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|K|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|L|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|M|8|@]|9|@]|A|$]]|$1|I|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|J|$]]

Another approach to test just for a JSON response (not that the content within contains an expected value), is to parse the response using ActiveSupport:

<pre><code>ActiveSupport::JSON.decode(response.body).should_not be_nil
</code></pre>

If the response is not parsable JSON an exception will be thrown and the test will fail.

blocks|key|767962|text|您可以查看'Content-Type'报头来查看它是否正确？|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|767963|response.header['Content-Type'].should+include+'text/javascript'|code-block|syntax|javascript|767964|entityMap^0|5|E|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@$9|N|A|O|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|P|8|@]|D|@]|E|$I|J]]|$1|K|3|-4|5|6|7|Q|8|@]|D|@]|E|$]]]|L|$]]

You could look into the <code>'Content-Type'</code> header to see that it is correct?

<pre><code>response.header['Content-Type'].should include 'text/javascript'
</code></pre>

blocks|key|768170|text|当使用Rails5(目前仍处于测试阶段)时，测试响应上有一个新方法parsed_body，它将返回经过解析的响应，即最后一个请求的编码位置。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|768171|GitHub上的提交：https://github.com/rails/rails/commit/eee3534b|768172|entityMap|0|LINK|mutability|MUTABLE|url|https://github.com/rails/rails/commit/eee3534b^0|X|B|0|B|1A|0|0^^$0|@$1|2|3|4|5|6|7|P|8|@$9|Q|A|R|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|S|8|@]|D|@$9|T|A|U|1|V]]|E|$]]|$1|H|3|-4|5|6|7|W|8|@]|D|@]|E|$]]]|I|$J|$5|K|L|M|E|$N|O]]]]

When using Rails 5 (currently still in beta), there's a new method, <code>parsed_body</code> on the test response, which will return the response parsed as what the last request was encoded at.

The commit on GitHub: <a href="https://github.com/rails/rails/commit/eee3534b" rel="noreferrer">https://github.com/rails/rails/commit/eee3534b</a>

blocks|key|768359|text|JSON比较解决方案|type|unstyled|depth|inlineStyleRanges|entityRanges|data|768360|产生一个干净但可能很大的差异：|768361|actual+=+JSON.parse(response.body,+symbolize_names:+true)
expected+=+{+foo:+"bar"+}
expect(actual).to+eq+expected|code-block|syntax|javascript|768362|来自真实数据的控制台输出示例：|768363|expected:+{:story=>{:id=>1,+:name=>"The+Shire"}}
+++++got:+{:story=>{:id=>1,+:name=>"The+Shire",+:description=>nil,+:body=>nil,+:number=>1}}

+++(compared+using+==)

+++Diff:
+++@@+-1,2+%2B1,2+@@
+++-:story+=>+{:id=>1,+:name=>"The+Shire"},
+++%2B:story+=>+{:id=>1,+:name=>"The+Shire",+:description=>nil,+...}|768364|(感谢@floatingrock的评论)|768365|字符串比较解决方案|768366|如果你想要一个铁板一块的解决方案，你应该避免使用解析器，因为解析器可能引入错误的正等式；将响应体与字符串进行比较。例如：|768367|actual+=+response.body
expected+=+({+foo:+"bar"+}).to_json
expect(actual).to+eq+expected|768368|但第二种解决方案在视觉上不太友好，因为它使用了序列化的JSON，其中会包含许多转义引号。|768369|自定义匹配器解决方案|768370|我倾向于给自己写一个自定义匹配器，它能更好地精确定位JSON路径不同的递归槽。将以下内容添加到rspec宏中：|768371|def+expect_response(actual,+expected_status,+expected_body+=+nil)
++expect(response).to+have_http_status(expected_status)
++if+expected_body
++++body+=+JSON.parse(actual.body,+symbolize_names:+true)
++++expect_json_eq(body,+expected_body)
++end
end

def+expect_json_eq(actual,+expected,+path+=+"")
++expect(actual.class).to+eq(expected.class),+"Type+mismatch+at+path:+#{path}"
++if+expected.class+==+Hash
++++expect(actual.keys).to+match_array(expected.keys),+"Keys+mismatch+at+path:+#{path}"
++++expected.keys.each+do+%7Ckey%7C
++++++expect_json_eq(actual[key],+expected[key],+"#{path}/:#{key}")
++++end
++elsif+expected.class+==+Array
++++expected.each_with_index+do+%7Ce,+index%7C
++++++expect_json_eq(actual[index],+expected[index],+"#{path}[#{index}]")
++++end
++else
++++expect(actual).to+eq(expected),+"Type+#{expected.class}+expected+#{expected.inspect}+but+got+#{actual.inspect}+at+path:+#{path}"
++end
end|768372|用法示例1：|768373|expect_response(response,+:no_content)|768374|用法示例2：|768375|expect_response(response,+:ok,+{
++story:+{
++++id:+1,
++++name:+"Shire+Burning",
++++revisions:+[+...+],
++}
})|768376|输出示例：|768377|Type+String+expected+"Shire+Burning"+but+got+"Shire+Burnin"+at+path:+/:story/:name|768378|另一个示例输出演示了嵌套数组中的深度不匹配：|768379|Type+Integer+expected+2+but+got+1+at+path:+/:story/:revisions[0]/:version|768380|如您所见，输出准确地告诉您应该在何处修复预期的JSON。|768381|entityMap^0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|1M|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|1N|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|1O|8|@]|9|@]|A|$G|H]]|$1|I|3|J|5|6|7|1P|8|@]|9|@]|A|$]]|$1|K|3|L|5|F|7|1Q|8|@]|9|@]|A|$G|H]]|$1|M|3|N|5|6|7|1R|8|@]|9|@]|A|$]]|$1|O|3|P|5|6|7|1S|8|@]|9|@]|A|$]]|$1|Q|3|R|5|6|7|1T|8|@]|9|@]|A|$]]|$1|S|3|T|5|F|7|1U|8|@]|9|@]|A|$G|H]]|$1|U|3|V|5|6|7|1V|8|@]|9|@]|A|$]]|$1|W|3|X|5|6|7|1W|8|@]|9|@]|A|$]]|$1|Y|3|Z|5|6|7|1X|8|@]|9|@]|A|$]]|$1|10|3|11|5|F|7|1Y|8|@]|9|@]|A|$G|H]]|$1|12|3|13|5|6|7|1Z|8|@]|9|@]|A|$]]|$1|14|3|15|5|F|7|20|8|@]|9|@]|A|$G|H]]|$1|16|3|17|5|6|7|21|8|@]|9|@]|A|$]]|$1|18|3|19|5|F|7|22|8|@]|9|@]|A|$G|H]]|$1|1A|3|1B|5|6|7|23|8|@]|9|@]|A|$]]|$1|1C|3|1D|5|F|7|24|8|@]|9|@]|A|$G|H]]|$1|1E|3|1F|5|6|7|25|8|@]|9|@]|A|$]]|$1|1G|3|1H|5|F|7|26|8|@]|9|@]|A|$G|H]]|$1|1I|3|1J|5|6|7|27|8|@]|9|@]|A|$]]|$1|1K|3|-4|5|6|7|28|8|@]|9|@]|A|$]]]|1L|$]]

<h2>JSON comparison solution</h2>

Yields a clean but potentially large Diff:

<pre><code>actual = JSON.parse(response.body, symbolize_names: true)
expected = { foo: "bar" }
expect(actual).to eq expected
</code></pre>

Example of console output from real data:

<pre><code>expected: {:story=&gt;{:id=&gt;1, :name=&gt;"The Shire"}}
 got: {:story=&gt;{:id=&gt;1, :name=&gt;"The Shire", :description=&gt;nil, :body=&gt;nil, :number=&gt;1}}

 (compared using ==)

 Diff:
 @@ -1,2 +1,2 @@
 -:story =&gt; {:id=&gt;1, :name=&gt;"The Shire"},
 +:story =&gt; {:id=&gt;1, :name=&gt;"The Shire", :description=&gt;nil, ...}
</code></pre>

(Thanks to comment by @floatingrock)

<h2>String comparison solution</h2>

If you want an iron-clad solution, you should avoid using parsers which could introduce false positive equality; compare the response body against a string. e.g:

<pre><code>actual = response.body
expected = ({ foo: "bar" }).to_json
expect(actual).to eq expected
</code></pre>

But this second solution is less visually friendly as it uses serialized JSON which would include lots of escaped quotation marks.

<h2>Custom matcher solution</h2>

I tend to write myself a custom matcher that does a much better job of pinpointing at exactly which recursive slot the JSON paths differ. Add the following to your rspec macros:

<pre><code>def expect_response(actual, expected_status, expected_body = nil)
 expect(response).to have_http_status(expected_status)
 if expected_body
 body = JSON.parse(actual.body, symbolize_names: true)
 expect_json_eq(body, expected_body)
 end
end

def expect_json_eq(actual, expected, path = "")
 expect(actual.class).to eq(expected.class), "Type mismatch at path: #{path}"
 if expected.class == Hash
 expect(actual.keys).to match_array(expected.keys), "Keys mismatch at path: #{path}"
 expected.keys.each do |key|
 expect_json_eq(actual[key], expected[key], "#{path}/:#{key}")
 end
 elsif expected.class == Array
 expected.each_with_index do |e, index|
 expect_json_eq(actual[index], expected[index], "#{path}[#{index}]")
 end
 else
 expect(actual).to eq(expected), "Type #{expected.class} expected #{expected.inspect} but got #{actual.inspect} at path: #{path}"
 end
end
</code></pre>

Example of usage 1:

<pre><code>expect_response(response, :no_content)
</code></pre>

Example of usage 2:

<pre><code>expect_response(response, :ok, {
 story: {
 id: 1,
 name: "Shire Burning",
 revisions: [ ... ],
 }
})
</code></pre>

Example output:

<pre><code>Type String expected "Shire Burning" but got "Shire Burnin" at path: /:story/:name
</code></pre>

Another example output to demonstrate a mismatch deep in a nested array:

<pre><code>Type Integer expected 2 but got 1 at path: /:story/:revisions[0]/:version
</code></pre>

As you can see, the output tells you EXACTLY where to fix your expected JSON.

blocks|key|983365|text|如果您想利用diff+Rspec提供的散列，最好解析正文并与散列进行比较。我发现的最简单的方法是：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|983366|it+'asserts+json+body'+do
++expected_body+=+{
++++my:+'json',
++++hash:+'ok'
++}.stringify_keys

++expect(JSON.parse(response.body)).to+eql(expected_body)
end|code-block|syntax|javascript|983367|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

If you want to take advantage of the hash diff Rspec provides, it is better to parse the body and compare against a hash. Simplest way I've found:

<pre><code>it 'asserts json body' do
 expected_body = {
 my: 'json',
 hash: 'ok'
 }.stringify_keys

 expect(JSON.parse(response.body)).to eql(expected_body)
end
</code></pre>

blocks|key|983159|text|我在这里找到了一个客户匹配器：https://raw.github.com/gist/917903/92d7101f643e07896659f84609c117c4c279dfad/have_content_type.rb|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|983160|将其放在spec/+support+/matcher/+this+_content_type.rb中，并确保在spec/spec_helper.rb中加载来自support的内容，如下所示|983161|Dir[Rails.root.join('spec/support/**/*.rb')].each+{%7Cf%7C+require+f}|code-block|syntax|javascript|983162|这是代码本身，以防它从给定的链接中消失。|983163|RSpec::Matchers.define+:have_content_type+do+%7Ccontent_type%7C
++CONTENT_HEADER_MATCHER+=+/%5E(.*?)(?:;+charset=(.*))?$/

++chain+:with_charset+do+%7Ccharset%7C
++++@charset+=+charset
++end

++match+do+%7Cresponse%7C
++++_,+content,+charset+=+*content_type_header.match(CONTENT_HEADER_MATCHER).to_a

++++if+@charset
++++++@charset+==+charset+&&+content+==+content_type
++++else
++++++content+==+content_type
++++end
++end

++failure_message_for_should+do+%7Cresponse%7C
++++if+@charset
++++++"Content+type+#{content_type_header.inspect}+should+match+#{content_type.inspect}+with+charset+#{@charset}"
++++else
++++++"Content+type+#{content_type_header.inspect}+should+match+#{content_type.inspect}"
++++end
++end

++failure_message_for_should_not+do+%7Cmodel%7C
++++if+@charset
++++++"Content+type+#{content_type_header.inspect}+should+not+match+#{content_type.inspect}+with+charset+#{@charset}"
++++else
++++++"Content+type+#{content_type_header.inspect}+should+not+match+#{content_type.inspect}"
++++end
++end

++def+content_type_header
++++response.headers['Content-Type']
++end
end|983164|entityMap|0|LINK|mutability|MUTABLE|url|https://raw.github.com/gist/917903/92d7101f643e07896659f84609c117c4c279dfad/have_content_type.rb^0|F|2O|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|W|8|@]|9|@$A|X|B|Y|1|Z]]|C|$]]|$1|D|3|E|5|6|7|10|8|@]|9|@]|C|$]]|$1|F|3|G|5|H|7|11|8|@]|9|@]|C|$I|J]]|$1|K|3|L|5|6|7|12|8|@]|9|@]|C|$]]|$1|M|3|N|5|H|7|13|8|@]|9|@]|C|$I|J]]|$1|O|3|-4|5|6|7|14|8|@]|9|@]|C|$]]]|P|$Q|$5|R|S|T|C|$U|V]]]]

I found a customer matcher here: <a href="https://raw.github.com/gist/917903/92d7101f643e07896659f84609c117c4c279dfad/have_content_type.rb" rel="nofollow">https://raw.github.com/gist/917903/92d7101f643e07896659f84609c117c4c279dfad/have_content_type.rb</a>

Put it in spec/support/matchers/have_content_type.rb and make sure to load stuff from support with something like this in you spec/spec_helper.rb

<pre><code>Dir[Rails.root.join('spec/support/**/*.rb')].each {|f| require f}
</code></pre>

Here is the code itself, just in case it disappeared from the given link.

<pre><code>RSpec::Matchers.define :have_content_type do |content_type|
 CONTENT_HEADER_MATCHER = /^(.*?)(?:; charset=(.*))?$/

 chain :with_charset do |charset|
 @charset = charset
 end

 match do |response|
 _, content, charset = *content_type_header.match(CONTENT_HEADER_MATCHER).to_a

 if @charset
 @charset == charset &amp;&amp; content == content_type
 else
 content == content_type
 end
 end

 failure_message_for_should do |response|
 if @charset
 "Content type #{content_type_header.inspect} should match #{content_type.inspect} with charset #{@charset}"
 else
 "Content type #{content_type_header.inspect} should match #{content_type.inspect}"
 end
 end

 failure_message_for_should_not do |model|
 if @charset
 "Content type #{content_type_header.inspect} should not match #{content_type.inspect} with charset #{@charset}"
 else
 "Content type #{content_type_header.inspect} should not match #{content_type.inspect}"
 end
 end

 def content_type_header
 response.headers['Content-Type']
 end
end
</code></pre>

I have the following code in my controller:

<pre><code>format.json { render :json =&gt; { 
 :flashcard =&gt; @flashcard,
 :lesson =&gt; @lesson,
 :success =&gt; true
} 
</code></pre>

In my RSpec controller test I want to verify that a certain scenario does receive a success json response so I had the following line:

<pre><code>controller.should_receive(:render).with(hash_including(:success =&gt; true))
</code></pre>

Although when I run my tests I get the following error:

<pre><code>Failure/Error: controller.should_receive(:render).with(hash_including(:success =&gt; false))
 (#&lt;AnnoController:0x00000002de0560&gt;).render(hash_including(:success=&gt;false))
 expected: 1 time
 received: 0 times
</code></pre>

Am I checking the response incorrectly?

How to check for a JSON response using RSpec?

GitHub

JSON

我的控制器中有以下代码：format.json { render :json => {         :flashcard  => @flashcard,        :lesson     => @lesson,        :success    => true} 在我的RSpec控制器测试中，我想验证某个场景确实接收到了成功的json响应，所以我有下面这行代码：controller.s

问如何使用RSpec检查JSON响应？
EN

回答 10

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何使用RSpec检查JSON响应？EN

回答 10

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何使用RSpec检查JSON响应？
EN