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

Adds rswag to test and development so rake tasks work

Browse Source 
Adds to swagger_Formatter to remove injected body parameters since those are 2.0 and ont 3.0 compliant

Adds to example_group_helpers to only automatically save request examples in the swagger output on 2xx response, since otherwise it was getting clobbered
This commit is contained in:
Jay Danielian 2019-07-07 22:57:55 -04:00
parent 297cc447c8
commit 0093efd4bf
5 changed files with 66 additions and 186 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Gemfile
View File

@ -31,6 +31,7 @@ end
group :development do group :development do
gem 'guard-rspec', require: false gem 'guard-rspec', require: false
gem 'rswag-specs', path: './rswag-specs'
gem 'rubocop' gem 'rubocop'
end end

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

@ -42,6 +42,8 @@ module Rswag
# TODO: setup travis CI? # TODO: setup travis CI?
# MUST HAVES # MUST HAVES
# TODO: look at integrating and documenting the rest of the responses in the blog_spec and get a clean 3.0 output
# Then can look at handling different request_body things like $ref, etc
# TODO: look at adding request_body method to handle diffs in Open API 2.0 to 3.0 # TODO: look at adding request_body method to handle diffs in Open API 2.0 to 3.0
# TODO: look at adding examples in content request_body # TODO: look at adding examples in content request_body
# https://swagger.io/docs/specification/describing-request-body/ # https://swagger.io/docs/specification/describing-request-body/
@ -123,7 +125,7 @@ module Rswag
end end
else else
before do |example| before do |example|
submit_request(example.metadata) submit_request(example.metadata) #
end end
it "returns a #{metadata[:response][:code]} response" do |example| it "returns a #{metadata[:response][:code]} response" do |example|
@ -137,12 +139,14 @@ module Rswag
if body_parameter && respond_to?(body_parameter[:name]) && example.metadata[:operation][:requestBody][:content]['application/json'] if body_parameter && respond_to?(body_parameter[:name]) && example.metadata[:operation][:requestBody][:content]['application/json']
# save response examples by default # save response examples by default
example.metadata[:response][:examples] = { 'application/json' => JSON.parse(response.body, symbolize_names: true) } unless response.body.to_s.empty? example.metadata[:response][:examples] = { 'application/json' => JSON.parse(response.body, symbolize_names: true) } unless response.body.to_s.empty?
# save request examples using the let(:param_name) { REQUEST_BODY_HASH } syntax in the test # save request examples using the let(:param_name) { REQUEST_BODY_HASH } syntax in the test
example.metadata[:operation][:requestBody][:content]['application/json'] = { examples: {} } unless example.metadata[:operation][:requestBody][:content]['application/json'][:examples] if response.code.to_s =~ /^2\d{2}$/
json_request_examples = example.metadata[:operation][:requestBody][:content]['application/json'][:examples] example.metadata[:operation][:requestBody][:content]['application/json'] = { examples: {} } unless example.metadata[:operation][:requestBody][:content]['application/json'][:examples]
json_request_examples[body_parameter[:name]] = { value: send(body_parameter[:name]) } json_request_examples = example.metadata[:operation][:requestBody][:content]['application/json'][:examples]
example.metadata[:operation][:requestBody][:content]['application/json'][:examples] = json_request_examples json_request_examples[body_parameter[:name]] = { value: send(body_parameter[:name]) }
example.metadata[:operation][:requestBody][:content]['application/json'][:examples] = json_request_examples
end
end end
end end
end end

27
rswag-specs/lib/rswag/specs/swagger_formatter.rb
View File

@ -34,6 +34,15 @@ module Rswag
def stop(_notification = nil) def stop(_notification = nil)
@config.swagger_docs.each do |url_path, doc| @config.swagger_docs.each do |url_path, doc|
# remove 2.0 parameters
doc[:paths].each_pair do |_k, v|
v.each_pair do |_verb, value|
if value&.dig(:parameters)
value[:parameters].reject! { |p| p[:in] == :body }
end
end
end
file_path = File.join(@config.swagger_root, url_path) file_path = File.join(@config.swagger_root, url_path)
dirname = File.dirname(file_path) dirname = File.dirname(file_path)
FileUtils.mkdir_p dirname unless File.exist?(dirname) FileUtils.mkdir_p dirname unless File.exist?(dirname)
@ -52,25 +61,19 @@ module Rswag
response_code = metadata[:response][:code] response_code = metadata[:response][:code]
response = metadata[:response].reject { |k, _v| k == :code } response = metadata[:response].reject { |k, _v| k == :code }
if response_code.to_s == '201' # need to merge in to response
# need to merge in to resppnse if response[:examples]&.dig('application/json')
if response[:examples]&.dig('application/json') example = response[:examples].dig('application/json').dup
example = response[:examples].dig('application/json').dup response.merge!(content: { 'application/json' => { example: example } })
response.merge!(content: { 'application/json' => { example: example } }) response.delete(:examples)
response.delete(:examples)
end
end end
verb = metadata[:operation][:verb] verb = metadata[:operation][:verb]
operation = metadata[:operation] operation = metadata[:operation]
.reject { |k, _v| k == :verb } .reject { |k, _v| k == :verb }
.merge(responses: { response_code => response }) .merge(responses: { response_code => response })
# can remove the 2.0 compliant body incoming parameters
if operation&.dig(:parameters)
operation[:parameters].reject! { |p| p[:in] == :body }
end
path_template = metadata[:path_item][:template] path_template = metadata[:path_item][:template]
path_item = metadata[:path_item] path_item = metadata[:path_item]
.reject { |k, _v| k == :template } .reject { |k, _v| k == :template }

2
rswag-specs/lib/tasks/rswag-specs_tasks.rake
View File

@ -6,7 +6,7 @@ namespace :rswag do
desc 'Generate Swagger JSON files from integration specs' desc 'Generate Swagger JSON files from integration specs'
RSpec::Core::RakeTask.new('swaggerize') do |t| RSpec::Core::RakeTask.new('swaggerize') do |t|
t.pattern = 'spec/requests/**/*_spec.rb, spec/api/**/*_spec.rb, spec/integration/**/*_spec.rb' t.pattern = 'spec/requests/**/*_spec.rb, spec/api/**/*_spec.rb, spec/integration/**/*_spec.rb'
# TODO: fix this, as dry-run is always true despite what is in the config
# NOTE: rspec 2.x support # NOTE: rspec 2.x support
if Rswag::Specs::RSPEC_VERSION > 2 && Rswag::Specs.config.swagger_dry_run if Rswag::Specs::RSPEC_VERSION > 2 && Rswag::Specs.config.swagger_dry_run
t.rspec_opts = [ '--format Rswag::Specs::SwaggerFormatter', '--dry-run', '--order defined' ] t.rspec_opts = [ '--format Rswag::Specs::SwaggerFormatter', '--dry-run', '--order defined' ]

206
test-app/swagger/v1/swagger.json
View File

@ -5,81 +5,6 @@
"version": "v1" "version": "v1"
}, },
"paths": { "paths": {
"/auth-tests/basic": {
"post": {
"summary": "Authenticates with basic auth",
"tags": [
"Auth Tests"
],
"operationId": "testBasicAuth",
"security": [
{
"basic_auth": [
]
}
],
"responses": {
"204": {
"description": "Valid credentials"
},
"401": {
"description": "Invalid credentials"
}
}
}
},
"/auth-tests/api-key": {
"post": {
"summary": "Authenticates with an api key",
"tags": [
"Auth Tests"
],
"operationId": "testApiKey",
"security": [
{
"api_key": [
]
}
],
"responses": {
"204": {
"description": "Valid credentials"
},
"401": {
"description": "Invalid credentials"
}
}
}
},
"/auth-tests/basic-and-api-key": {
"post": {
"summary": "Authenticates with basic auth and api key",
"tags": [
"Auth Tests"
],
"operationId": "testBasicAndApiKey",
"security": [
{
"basic_auth": [
],
"api_key": [
]
}
],
"responses": {
"204": {
"description": "Valid credentials"
},
"401": {
"description": "Invalid credentials"
}
}
}
},
"/blogs": { "/blogs": {
"post": { "post": {
"summary": "Creates a blog", "summary": "Creates a blog",
@ -94,23 +19,55 @@
"produces": [ "produces": [
"application/json" "application/json"
], ],
"parameters": [ "requestBody": {
{ "required": true,
"name": "blog", "content": {
"in": "body", "application/json": {
"schema": { "examples": {
"$ref": "#/components/schemas/blog" "blog": {
"value": {
"blog": {
"title": "foo",
"content": "bar"
}
}
}
}
} }
} }
},
"parameters": [
], ],
"responses": { "responses": {
"201": { "201": {
"description": "blog created" "description": "blog created",
"content": {
"application/json": {
"example": {
"id": 1,
"title": "foo",
"content": "bar",
"thumbnail": null
}
}
}
}, },
"422": { "422": {
"description": "invalid request", "description": "invalid request",
"schema": { "schema": {
"$ref": "#/components/schemas/errors_object" "$ref": "#/components/schemas/errors_object"
},
"content": {
"application/json": {
"example": {
"errors": {
"content": [
"can't be blank"
]
}
}
}
} }
} }
} }
@ -138,91 +95,6 @@
} }
} }
} }
},
"/blogs/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"type": "string",
"required": true
}
],
"get": {
"summary": "Retrieves a blog",
"tags": [
"Blogs"
],
"description": "Retrieves a specific blog by id",
"operationId": "getBlog",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "blog found",
"headers": {
"ETag": {
"type": "string"
},
"Last-Modified": {
"type": "string"
},
"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"
}
}
},
"404": {
"description": "blog not found"
}
}
}
},
"/blogs/{id}/upload": {
"parameters": [
{
"name": "id",
"in": "path",
"type": "string",
"required": true
}
],
"put": {
"summary": "Uploads a blog thumbnail",
"tags": [
"Blogs"
],
"description": "Upload a thumbnail for specific blog by id",
"operationId": "uploadThumbnailBlog",
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "file",
"in": "formData",
"type": "file",
"required": true
}
],
"responses": {
"200": {
"description": "blog updated"
}
}
}
} }
}, },
"servers": [ "servers": [