105 lines
3.6 KiB
Ruby
105 lines
3.6 KiB
Ruby
require 'spec_helper'
|
|
|
|
describe 'response' do
|
|
include_context "#{MODEL_PARSER} swagger example"
|
|
|
|
before :all do
|
|
module TheApi
|
|
class ResponseApi < Grape::API
|
|
format :json
|
|
|
|
desc 'This returns something',
|
|
params: Entities::UseResponse.documentation,
|
|
failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }]
|
|
post '/params_response' do
|
|
{ 'declared_params' => declared(params) }
|
|
end
|
|
|
|
desc 'This returns something',
|
|
entity: Entities::UseResponse,
|
|
failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }]
|
|
get '/entity_response' do
|
|
{ 'declared_params' => declared(params) }
|
|
end
|
|
|
|
desc 'This returns something',
|
|
entity: Entities::UseItemResponseAsType,
|
|
failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }]
|
|
get '/nested_type' do
|
|
{ 'declared_params' => declared(params) }
|
|
end
|
|
|
|
add_swagger_documentation
|
|
end
|
|
end
|
|
end
|
|
|
|
def app
|
|
TheApi::ResponseApi
|
|
end
|
|
|
|
describe 'uses nested type as response object' do
|
|
subject do
|
|
get '/swagger_doc/nested_type'
|
|
JSON.parse(last_response.body)
|
|
end
|
|
specify do
|
|
expect(subject['paths']['/nested_type']['get']).to eql(
|
|
'description' => 'This returns something',
|
|
'produces' => ['application/json'],
|
|
'responses' => {
|
|
'200' => { 'description' => 'This returns something', 'schema' => { '$ref' => '#/definitions/UseItemResponseAsType' } },
|
|
'400' => { 'description' => 'NotFound', 'schema' => { '$ref' => '#/definitions/ApiError' } }
|
|
},
|
|
'tags' => ['nested_type'],
|
|
'operationId' => 'getNestedType')
|
|
expect(subject['definitions']).to eql(swagger_nested_type)
|
|
end
|
|
end
|
|
|
|
describe 'uses entity as response object' do
|
|
subject do
|
|
get '/swagger_doc/entity_response'
|
|
JSON.parse(last_response.body)
|
|
end
|
|
|
|
specify do
|
|
expect(subject['paths']['/entity_response']['get']).to eql(
|
|
'description' => 'This returns something',
|
|
'produces' => ['application/json'],
|
|
'responses' => {
|
|
'200' => { 'description' => 'This returns something', 'schema' => { '$ref' => '#/definitions/UseResponse' } },
|
|
'400' => { 'description' => 'NotFound', 'schema' => { '$ref' => '#/definitions/ApiError' } }
|
|
},
|
|
'tags' => ['entity_response'],
|
|
'operationId' => 'getEntityResponse')
|
|
expect(subject['definitions']).to eql(swagger_entity_as_response_object)
|
|
end
|
|
end
|
|
|
|
describe 'uses params as response object' do
|
|
subject do
|
|
get '/swagger_doc/params_response'
|
|
JSON.parse(last_response.body)
|
|
end
|
|
|
|
specify do
|
|
expect(subject['paths']['/params_response']['post']).to eql(
|
|
'description' => 'This returns something',
|
|
'produces' => ['application/json'],
|
|
'consumes' => ['application/json'],
|
|
'parameters' => [
|
|
{ 'in' => 'formData', 'name' => 'description', 'type' => 'string', 'required' => false },
|
|
{ 'in' => 'formData', 'name' => '$responses', 'type' => 'array', 'items' => { 'type' => 'string' }, 'required' => false }
|
|
],
|
|
'responses' => {
|
|
'201' => { 'description' => 'This returns something' },
|
|
'400' => { 'description' => 'NotFound', 'schema' => { '$ref' => '#/definitions/ApiError' } }
|
|
},
|
|
'tags' => ['params_response'],
|
|
'operationId' => 'postParamsResponse')
|
|
expect(subject['definitions']).to eql(swagger_params_as_response_object)
|
|
end
|
|
end
|
|
end
|