ditkrg/rswag
4
0
Fork 0
mirror of https://github.com/ditkrg/rswag.git synced 2026-01-24 23:06:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Support setting examples for response

Browse Source 
Add helper method `response_examples` to inject response examples to swagger
This commit is contained in:
vinhbachsy 2016-10-18 21:44:04 +08:00
parent 3506fee3d0
commit 10dd37896f
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
rswag-specs/lib/rswag/specs/example_group_helpers.rb
View File

@ -61,6 +61,10 @@ module Rswag
metadata[:response][:headers][name] = attributes metadata[:response][:headers][name] = attributes
end end
def response_examples(example)
metadata[:response][:examples] = example
end
def run_test! def run_test!
# NOTE: rspec 2.x support # NOTE: rspec 2.x support
if RSPEC_VERSION < 3 if RSPEC_VERSION < 3

6
test-app/spec/integration/blogs_spec.rb
View File

@ -52,6 +52,12 @@ describe 'Blogs API', type: :request, swagger_doc: 'v1/swagger.json' do
response '200', 'blog found' do response '200', 'blog found' do
schema '$ref' => '#/definitions/blog' schema '$ref' => '#/definitions/blog'
response_examples 'application/json' => {
id: 1,
title: 'Hello world!',
content: 'Hello world and hello universe. Thank you all very much!!!'
}
let(:blog) { Blog.create(title: 'foo', content: 'bar') } let(:blog) { Blog.create(title: 'foo', content: 'bar') }
let(:id) { blog.id } let(:id) { blog.id }
run_test! run_test!