Generate rswag initializers

Done via rswag rake tasks and tidied up a bit.
This commit is contained in:
Matt-Yorkley
2021-06-21 09:21:41 +01:00
committed by Maikel Linke
parent 3a6fc59f80
commit ae2726fc6b
2 changed files with 32 additions and 0 deletions

View File

@@ -0,0 +1,15 @@
# frozen_string_literal: true
Rswag::Api.configure do |config|
# Specify a root folder where Swagger JSON files are located
# This is used by the Swagger middleware to serve requests for API descriptions
# NOTE: If you're using rswag-specs to generate Swagger, you'll need to ensure
# that it's configured to generate files in the same folder
config.swagger_root = Rails.root.join("swagger")
# Inject a lamda function to alter the returned Swagger prior to serialization
# The function will have access to the rack env for the current request
# For example, you could leverage this to dynamically assign the "host" property
#
# config.swagger_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
end

View File

@@ -0,0 +1,17 @@
# frozen_string_literal: true
Rswag::Ui.configure do |config|
# List the Swagger endpoints that you want to be documented through the
# swagger-ui. The first parameter is the path (absolute or relative to the UI
# host) to the corresponding endpoint and the second is a title that will be
# displayed in the document selector.
# NOTE: If you're using rspec-api to expose Swagger files
# (under swagger_root) as JSON or YAML endpoints, then the list below should
# correspond to the relative paths for those endpoints.
config.swagger_endpoint '/api-docs/v1/swagger.yaml', 'API V1 Docs'
# Add Basic Auth in case your API is private
# config.basic_auth_enabled = true
# config.basic_auth_credentials 'username', 'password'
end