mirror of
https://github.com/ditkrg/rswag.git
synced 2026-01-25 15:22:56 +00:00
Reverted some files related to definitions changes
This commit is contained in:
Greg Myers
@@ -1,5 +1,3 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require 'swagger_helper'
|
||||
|
||||
RSpec.describe 'Blogs API', type: :request, swagger_doc: 'v1/swagger.json' do
|
||||
@@ -12,24 +10,19 @@ RSpec.describe 'Blogs API', type: :request, swagger_doc: 'v1/swagger.json' do
|
||||
operationId 'createBlog'
|
||||
consumes 'application/json'
|
||||
produces 'application/json'
|
||||
parameter name: :blog, in: :body, schema: { '$ref' => '#/definitions/blog' }
|
||||
|
||||
request_body_json schema: { '$ref' => '#/components/schemas/blog' },
|
||||
examples: :blog
|
||||
|
||||
request_body_text_plain
|
||||
request_body_xml schema: { '$ref' => '#/components/schemas/blog' }
|
||||
|
||||
let(:blog) { { blog: { title: 'foo', content: 'bar' } } }
|
||||
let(:blog) { { title: 'foo', content: 'bar' } }
|
||||
|
||||
response '201', 'blog created' do
|
||||
schema '$ref' => '#/components/schemas/blog'
|
||||
# schema '$ref' => '#/definitions/blog'
|
||||
run_test!
|
||||
end
|
||||
|
||||
response '422', 'invalid request' do
|
||||
schema '$ref' => '#/components/schemas/errors_object'
|
||||
let(:blog) { { blog: { title: 'foo' } } }
|
||||
schema '$ref' => '#/definitions/errors_object'
|
||||
|
||||
let(:blog) { { title: 'foo' } }
|
||||
run_test! do |response|
|
||||
expect(response.body).to include("can't be blank")
|
||||
end
|
||||
@@ -46,69 +39,18 @@ RSpec.describe 'Blogs API', type: :request, swagger_doc: 'v1/swagger.json' do
|
||||
let(:keywords) { 'foo bar' }
|
||||
|
||||
response '200', 'success' do
|
||||
schema type: 'array', items: { '$ref' => '#/components/schemas/blog' }
|
||||
run_test!
|
||||
schema type: 'array', items: { '$ref' => '#/definitions/blog' }
|
||||
end
|
||||
|
||||
response '406', 'unsupported accept header' do
|
||||
let(:Accept) { 'application/foo' }
|
||||
let(:'Accept') { 'application/foo' }
|
||||
run_test!
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
path '/blogs/flexible' do
|
||||
post 'Creates a blog flexible body' do
|
||||
tags 'Blogs'
|
||||
description 'Creates a flexible blog from provided data'
|
||||
operationId 'createFlexibleBlog'
|
||||
consumes 'application/json'
|
||||
produces 'application/json'
|
||||
|
||||
request_body_json schema: {
|
||||
:oneOf => [{'$ref' => '#/components/schemas/blog'},
|
||||
{'$ref' => '#/components/schemas/flexible_blog'}]
|
||||
},
|
||||
examples: :flexible_blog
|
||||
|
||||
let(:flexible_blog) { { blog: { headline: 'my headline', text: 'my text' } } }
|
||||
|
||||
response '201', 'flexible blog created' do
|
||||
schema :oneOf => [{'$ref' => '#/components/schemas/blog'},{'$ref' => '#/components/schemas/flexible_blog'}]
|
||||
run_test!
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
path '/blogs/alternate' do
|
||||
post 'Creates a blog - different :examples in requestBody' do
|
||||
tags 'Blogs'
|
||||
description 'Creates a new blog from provided data'
|
||||
operationId 'createAlternateBlog'
|
||||
consumes 'application/json'
|
||||
produces 'application/json'
|
||||
|
||||
# NOTE: the externalValue: http://... is valid 3.0 spec, but swagger-UI does NOT support it yet
|
||||
# https://github.com/swagger-api/swagger-ui/issues/5433
|
||||
request_body_json schema: { '$ref' => '#/components/schemas/blog' },
|
||||
examples: [:blog, {name: :external_blog,
|
||||
externalValue: 'http://api.sample.org/myjson_example'},
|
||||
{name: :another_example,
|
||||
'$ref' => '#/components/examples/flexible_blog_example'}]
|
||||
|
||||
let(:blog) { { blog: { title: 'alt title', content: 'alt bar' } } }
|
||||
|
||||
response '201', 'blog created' do
|
||||
schema '$ref' => '#/components/schemas/blog'
|
||||
run_test!
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
|
||||
path '/blogs/{id}' do
|
||||
|
||||
parameter name: :id, in: :path, type: :string
|
||||
|
||||
let(:id) { blog.id }
|
||||
let(:blog) { Blog.create(title: 'foo', content: 'bar', thumbnail: 'thumbnail.png') }
|
||||
@@ -119,14 +61,12 @@ RSpec.describe 'Blogs API', type: :request, swagger_doc: 'v1/swagger.json' do
|
||||
operationId 'getBlog'
|
||||
produces 'application/json'
|
||||
|
||||
parameter name: :id, in: :path, type: :string
|
||||
|
||||
response '200', 'blog found' do
|
||||
header 'ETag', type: :string
|
||||
header 'Last-Modified', type: :string
|
||||
header 'Cache-Control', type: :string
|
||||
|
||||
schema '$ref' => '#/components/schemas/blog'
|
||||
schema '$ref' => '#/definitions/blog'
|
||||
|
||||
examples 'application/json' => {
|
||||
id: 1,
|
||||
@@ -146,23 +86,21 @@ RSpec.describe 'Blogs API', type: :request, swagger_doc: 'v1/swagger.json' do
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
path '/blogs/{id}/upload' do
|
||||
parameter name: :id, in: :path, type: :string
|
||||
|
||||
let(:id) { blog.id }
|
||||
let(:blog) { Blog.create(title: 'foo', content: 'bar') }
|
||||
|
||||
put 'Uploads a blog thumbnail' do
|
||||
parameter name: :id, in: :path, type: :string
|
||||
|
||||
tags 'Blogs'
|
||||
description 'Upload a thumbnail for specific blog by id'
|
||||
operationId 'uploadThumbnailBlog'
|
||||
consumes 'multipart/form-data'
|
||||
|
||||
request_body_multipart schema: {properties: {:orderId => { type: :integer }, file: { type: :string, format: :binary }} }
|
||||
parameter name: :file, :in => :formData, :type => :file, required: true
|
||||
|
||||
response '200', 'blog updated' do
|
||||
let(:file) { Rack::Test::UploadedFile.new(Rails.root.join('spec/fixtures/thumbnail.png')) }
|
||||
let(:file) { Rack::Test::UploadedFile.new(Rails.root.join("spec/fixtures/thumbnail.png")) }
|
||||
run_test!
|
||||
end
|
||||
end
|
||||
|
||||
170
test-app/spec/integration/new_blogs_spec.rb
Normal file
170
test-app/spec/integration/new_blogs_spec.rb
Normal file
@@ -0,0 +1,170 @@
|
||||
# # frozen_string_literal: true
|
||||
|
||||
# require 'swagger_helper'
|
||||
|
||||
# RSpec.describe 'Blogs API', type: :request, swagger_doc: 'v1/swagger.json' do
|
||||
# let(:api_key) { 'fake_key' }
|
||||
|
||||
# path '/blogs' do
|
||||
# post 'Creates a blog' do
|
||||
# tags 'Blogs'
|
||||
# description 'Creates a new blog from provided data'
|
||||
# operationId 'createBlog'
|
||||
# consumes 'application/json'
|
||||
# produces 'application/json'
|
||||
|
||||
# request_body_json schema: { '$ref' => '#/components/schemas/blog' },
|
||||
# examples: :blog
|
||||
|
||||
# request_body_text_plain
|
||||
# request_body_xml schema: { '$ref' => '#/components/schemas/blog' }
|
||||
|
||||
# let(:blog) { { blog: { title: 'foo', content: 'bar' } } }
|
||||
|
||||
# response '201', 'blog created' do
|
||||
# schema '$ref' => '#/components/schemas/blog'
|
||||
# run_test!
|
||||
# end
|
||||
|
||||
# response '422', 'invalid request' do
|
||||
# schema '$ref' => '#/components/schemas/errors_object'
|
||||
# let(:blog) { { blog: { title: 'foo' } } }
|
||||
|
||||
# run_test! do |response|
|
||||
# expect(response.body).to include("can't be blank")
|
||||
# end
|
||||
# end
|
||||
# end
|
||||
|
||||
# get 'Searches blogs' do
|
||||
# tags 'Blogs'
|
||||
# description 'Searches blogs by keywords'
|
||||
# operationId 'searchBlogs'
|
||||
# produces 'application/json'
|
||||
# parameter name: :keywords, in: :query, type: 'string'
|
||||
|
||||
# let(:keywords) { 'foo bar' }
|
||||
|
||||
# response '200', 'success' do
|
||||
# schema type: 'array', items: { '$ref' => '#/components/schemas/blog' }
|
||||
# run_test!
|
||||
# end
|
||||
|
||||
# response '406', 'unsupported accept header' do
|
||||
# let(:Accept) { 'application/foo' }
|
||||
# run_test!
|
||||
# end
|
||||
# end
|
||||
# end
|
||||
|
||||
# path '/blogs/flexible' do
|
||||
# post 'Creates a blog flexible body' do
|
||||
# tags 'Blogs'
|
||||
# description 'Creates a flexible blog from provided data'
|
||||
# operationId 'createFlexibleBlog'
|
||||
# consumes 'application/json'
|
||||
# produces 'application/json'
|
||||
|
||||
# request_body_json schema: {
|
||||
# :oneOf => [{'$ref' => '#/components/schemas/blog'},
|
||||
# {'$ref' => '#/components/schemas/flexible_blog'}]
|
||||
# },
|
||||
# examples: :flexible_blog
|
||||
|
||||
# let(:flexible_blog) { { blog: { headline: 'my headline', text: 'my text' } } }
|
||||
|
||||
# response '201', 'flexible blog created' do
|
||||
# schema :oneOf => [{'$ref' => '#/components/schemas/blog'},{'$ref' => '#/components/schemas/flexible_blog'}]
|
||||
# run_test!
|
||||
# end
|
||||
# end
|
||||
# end
|
||||
|
||||
# path '/blogs/alternate' do
|
||||
# post 'Creates a blog - different :examples in requestBody' do
|
||||
# tags 'Blogs'
|
||||
# description 'Creates a new blog from provided data'
|
||||
# operationId 'createAlternateBlog'
|
||||
# consumes 'application/json'
|
||||
# produces 'application/json'
|
||||
|
||||
# # NOTE: the externalValue: http://... is valid 3.0 spec, but swagger-UI does NOT support it yet
|
||||
# # https://github.com/swagger-api/swagger-ui/issues/5433
|
||||
# request_body_json schema: { '$ref' => '#/components/schemas/blog' },
|
||||
# examples: [:blog, {name: :external_blog,
|
||||
# externalValue: 'http://api.sample.org/myjson_example'},
|
||||
# {name: :another_example,
|
||||
# '$ref' => '#/components/examples/flexible_blog_example'}]
|
||||
|
||||
# let(:blog) { { blog: { title: 'alt title', content: 'alt bar' } } }
|
||||
|
||||
# response '201', 'blog created' do
|
||||
# schema '$ref' => '#/components/schemas/blog'
|
||||
# run_test!
|
||||
# end
|
||||
# end
|
||||
# end
|
||||
|
||||
|
||||
|
||||
# path '/blogs/{id}' do
|
||||
|
||||
|
||||
# let(:id) { blog.id }
|
||||
# let(:blog) { Blog.create(title: 'foo', content: 'bar', thumbnail: 'thumbnail.png') }
|
||||
|
||||
# get 'Retrieves a blog' do
|
||||
# tags 'Blogs'
|
||||
# description 'Retrieves a specific blog by id'
|
||||
# operationId 'getBlog'
|
||||
# produces 'application/json'
|
||||
|
||||
# parameter name: :id, in: :path, type: :string
|
||||
|
||||
# response '200', 'blog found' do
|
||||
# header 'ETag', type: :string
|
||||
# header 'Last-Modified', type: :string
|
||||
# header 'Cache-Control', type: :string
|
||||
|
||||
# schema '$ref' => '#/components/schemas/blog'
|
||||
|
||||
# examples 'application/json' => {
|
||||
# id: 1,
|
||||
# title: 'Hello world!',
|
||||
# content: 'Hello world and hello universe. Thank you all very much!!!',
|
||||
# thumbnail: 'thumbnail.png'
|
||||
# }
|
||||
|
||||
# let(:id) { blog.id }
|
||||
# run_test!
|
||||
# end
|
||||
|
||||
# response '404', 'blog not found' do
|
||||
# let(:id) { 'invalid' }
|
||||
# run_test!
|
||||
# end
|
||||
# end
|
||||
# end
|
||||
|
||||
|
||||
# path '/blogs/{id}/upload' do
|
||||
# let(:id) { blog.id }
|
||||
# let(:blog) { Blog.create(title: 'foo', content: 'bar') }
|
||||
|
||||
# put 'Uploads a blog thumbnail' do
|
||||
# parameter name: :id, in: :path, type: :string
|
||||
|
||||
# tags 'Blogs'
|
||||
# description 'Upload a thumbnail for specific blog by id'
|
||||
# operationId 'uploadThumbnailBlog'
|
||||
# consumes 'multipart/form-data'
|
||||
|
||||
# request_body_multipart schema: {properties: {:orderId => { type: :integer }, file: { type: :string, format: :binary }} }
|
||||
|
||||
# response '200', 'blog updated' do
|
||||
# let(:file) { Rack::Test::UploadedFile.new(Rails.root.join('spec/fixtures/thumbnail.png')) }
|
||||
# run_test!
|
||||
# end
|
||||
# end
|
||||
# end
|
||||
# end
|
||||
@@ -32,63 +32,39 @@ RSpec.configure do |config|
|
||||
}
|
||||
}
|
||||
],
|
||||
|
||||
components: {
|
||||
schemas: {
|
||||
errors_object: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
errors: { '$ref' => '#/components/schemas/errors_map' }
|
||||
}
|
||||
},
|
||||
errors_map: {
|
||||
type: 'object',
|
||||
additionalProperties: {
|
||||
type: 'array',
|
||||
items: { type: 'string' }
|
||||
}
|
||||
},
|
||||
blog: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'integer' },
|
||||
title: { type: 'string' },
|
||||
content: { type: 'string', nullable: true },
|
||||
thumbnail: { type: 'string', nullable: true }
|
||||
},
|
||||
required: %w[id title]
|
||||
},
|
||||
flexible_blog: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'integer' },
|
||||
headline: { type: 'string' },
|
||||
text: { type: 'string', nullable: true },
|
||||
thumbnail: { type: 'string', nullable:true }
|
||||
},
|
||||
required: %w[id headline]
|
||||
definitions: {
|
||||
errors_object: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
errors: { '$ref' => '#/definitions/errors_map' }
|
||||
}
|
||||
},
|
||||
examples: {
|
||||
flexible_blog_example: {
|
||||
summary: 'Sample example of a flexible blog',
|
||||
value: {
|
||||
id: 1,
|
||||
headline: 'This is a headline',
|
||||
text: 'Some sample text'
|
||||
}
|
||||
}
|
||||
},
|
||||
securitySchemes: {
|
||||
basic_auth: {
|
||||
type: :http,
|
||||
scheme: :basic
|
||||
},
|
||||
api_key: {
|
||||
type: :apiKey,
|
||||
name: 'api_key',
|
||||
in: :query
|
||||
errors_map: {
|
||||
type: 'object',
|
||||
additionalProperties: {
|
||||
type: 'array',
|
||||
items: { type: 'string' }
|
||||
}
|
||||
},
|
||||
blog: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
id: { type: 'integer' },
|
||||
title: { type: 'string' },
|
||||
content: { type: 'string', 'x-nullable': true },
|
||||
thumbnail: { type: 'string'}
|
||||
},
|
||||
required: [ 'id', 'title', 'content', 'thumbnail' ]
|
||||
}
|
||||
},
|
||||
securityDefinitions: {
|
||||
basic_auth: {
|
||||
type: :basic
|
||||
},
|
||||
api_key: {
|
||||
type: :apiKey,
|
||||
name: 'api_key',
|
||||
in: :query
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user