mirror of
https://github.com/ditkrg/rswag.git
synced 2026-01-25 15:22:56 +00:00
rename to rswag plus major refactor - almost a rewrite
This commit is contained in:
8
rswag-api/lib/generators/rswag/api/install/USAGE
Normal file
8
rswag-api/lib/generators/rswag/api/install/USAGE
Normal file
@@ -0,0 +1,8 @@
|
||||
Description:
|
||||
Adds rswag-api initializer for configuration
|
||||
|
||||
Example:
|
||||
rails generate rswag:api:install
|
||||
|
||||
This will create:
|
||||
config/initializers/rswag-api.rb
|
||||
@@ -0,0 +1,18 @@
|
||||
require 'rails/generators'
|
||||
|
||||
module Rswag
|
||||
module Api
|
||||
|
||||
class InstallGenerator < Rails::Generators::Base
|
||||
source_root File.expand_path('../templates', __FILE__)
|
||||
|
||||
def add_initializer
|
||||
template('rswag-api.rb', 'config/initializers/rswag-api.rb')
|
||||
end
|
||||
|
||||
def add_routes
|
||||
route("mount Rswag::Api::Engine => '/api-docs'")
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,14 @@
|
||||
Rswag::Api.configure do |c|
|
||||
|
||||
# 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
|
||||
c.swagger_root = Rails.root.to_s + '/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
|
||||
#
|
||||
#c.swagger_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
|
||||
end
|
||||
Reference in New Issue
Block a user