swagger_ui_engine_2 0.2.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +53 -9
- data/app/assets/javascripts/swagger_ui_engine_2/swagger-ui-bundle.js +1 -1
- data/app/assets/javascripts/swagger_ui_engine_2/swagger-ui-bundle.js.map +1 -1
- data/app/assets/javascripts/swagger_ui_engine_2/swagger-ui-es-bundle-core.js +1 -1
- data/app/assets/javascripts/swagger_ui_engine_2/swagger-ui-es-bundle-core.js.map +1 -1
- data/app/assets/javascripts/swagger_ui_engine_2/swagger-ui-es-bundle.js +1 -1
- data/app/assets/javascripts/swagger_ui_engine_2/swagger-ui-es-bundle.js.map +1 -1
- data/app/assets/javascripts/swagger_ui_engine_2/swagger-ui-standalone-preset.js +1 -1
- data/app/assets/javascripts/swagger_ui_engine_2/swagger-ui-standalone-preset.js.map +1 -1
- data/app/assets/javascripts/swagger_ui_engine_2/swagger-ui.js +1 -1
- data/app/assets/javascripts/swagger_ui_engine_2/swagger-ui.js.map +1 -0
- data/app/controllers/swagger_ui_engine2/swagger_docs_controller.rb +2 -2
- data/app/helpers/swagger_ui_engine_2/config_parser.rb +1 -2
- data/app/views/swagger_ui_engine2/swagger_docs/index.html.erb +2 -3
- data/lib/swagger_ui_engine_2/configuration.rb +4 -12
- data/lib/swagger_ui_engine_2/defaults.rb +2 -3
- data/lib/swagger_ui_engine_2/version.rb +1 -1
- metadata +7 -8
- data/app/assets/stylesheets/swagger_ui_engine_2/swagger-ui.js +0 -2
- data/app/assets/stylesheets/swagger_ui_engine_2/swagger-ui.js.map +0 -1
@@ -9,9 +9,9 @@ module SwaggerUiEngine2
|
|
9
9
|
def index
|
10
10
|
@swagger_url = @swagger_url[params[:id].to_sym] unless single_doc_url?
|
11
11
|
end
|
12
|
-
|
12
|
+
|
13
13
|
private
|
14
|
-
|
14
|
+
|
15
15
|
def set_configs
|
16
16
|
SwaggerUiEngine2::DEFAULTS.keys.each do |key|
|
17
17
|
instance_variable_set("@#{key}", self.send("set_#{key}"))
|
@@ -5,8 +5,7 @@ module SwaggerUiEngine2
|
|
5
5
|
|
6
6
|
define_method("set_#{default.first}") do
|
7
7
|
# set_swagger_url set_doc_expansion
|
8
|
-
#
|
9
|
-
# set_request_headers
|
8
|
+
# set_model_rendering ...
|
10
9
|
configuration.send("#{default.first}") || default.last
|
11
10
|
end
|
12
11
|
end
|
@@ -11,12 +11,11 @@
|
|
11
11
|
// Begin Swagger UI call region
|
12
12
|
const ui = SwaggerUIBundle({
|
13
13
|
url: url,
|
14
|
+
validatorUrl: "<%= @validator_url %>",
|
14
15
|
dom_id: '#swagger-ui',
|
15
16
|
deepLinking: true,
|
16
17
|
docExpansion: "<%= @doc_expansion %>",
|
17
|
-
jsonEditor: "<%= @json_editor %>",
|
18
18
|
defaultModelRendering: "<%= @model_rendering %>",
|
19
|
-
showRequestHeaders: "<%= @request_headers %>",
|
20
19
|
presets: [
|
21
20
|
SwaggerUIBundle.presets.apis,
|
22
21
|
SwaggerUIStandalonePreset
|
@@ -24,7 +23,7 @@
|
|
24
23
|
plugins: [
|
25
24
|
SwaggerUIBundle.plugins.DownloadUrl
|
26
25
|
],
|
27
|
-
layout: "
|
26
|
+
layout: "<%= @layout %>"
|
28
27
|
});
|
29
28
|
// End Swagger UI call region
|
30
29
|
|
@@ -1,23 +1,15 @@
|
|
1
1
|
module SwaggerUiEngine2
|
2
2
|
class Configuration
|
3
3
|
# Configurable options
|
4
|
-
OPTIONS = %i
|
4
|
+
OPTIONS = %i[
|
5
5
|
admin_username
|
6
6
|
admin_password
|
7
|
+
swagger_url
|
7
8
|
doc_expansion
|
8
|
-
json_editor
|
9
9
|
model_rendering
|
10
|
-
|
11
|
-
oauth_client_secret
|
12
|
-
oauth_realm
|
13
|
-
oauth_app_name
|
14
|
-
oauth_scope_separator
|
15
|
-
oauth_query_string_params
|
16
|
-
request_headers
|
17
|
-
swagger_url
|
18
|
-
translator_enabled
|
10
|
+
layout
|
19
11
|
validator_enabled
|
20
|
-
|
12
|
+
].freeze
|
21
13
|
|
22
14
|
attr_accessor(*OPTIONS)
|
23
15
|
end
|
@@ -2,9 +2,8 @@ module SwaggerUiEngine2
|
|
2
2
|
DEFAULTS = {
|
3
3
|
swagger_url: 'http://petstore.swagger.io/v2/swagger.json',
|
4
4
|
doc_expansion: 'none',
|
5
|
-
json_editor: false,
|
6
5
|
model_rendering: 'schema',
|
7
|
-
|
8
|
-
validator_url: '
|
6
|
+
layout: 'StandaloneLayout',
|
7
|
+
validator_url: 'https://validator.swagger.io/validator'
|
9
8
|
}.freeze
|
10
9
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: swagger_ui_engine_2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 1.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
|
-
- Israel
|
7
|
+
- Israel Barba
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-03-
|
11
|
+
date: 2022-03-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rails
|
@@ -38,7 +38,7 @@ dependencies:
|
|
38
38
|
- - ">="
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: '0'
|
41
|
-
description:
|
41
|
+
description: Mount Swagger UI web console as Rails engine
|
42
42
|
email:
|
43
43
|
- israelb.aceves@gmail.com
|
44
44
|
executables: []
|
@@ -60,11 +60,10 @@ files:
|
|
60
60
|
- app/assets/javascripts/swagger_ui_engine_2/swagger-ui-standalone-preset.js
|
61
61
|
- app/assets/javascripts/swagger_ui_engine_2/swagger-ui-standalone-preset.js.map
|
62
62
|
- app/assets/javascripts/swagger_ui_engine_2/swagger-ui.js
|
63
|
+
- app/assets/javascripts/swagger_ui_engine_2/swagger-ui.js.map
|
63
64
|
- app/assets/stylesheets/swagger_ui_engine_2/application.css
|
64
65
|
- app/assets/stylesheets/swagger_ui_engine_2/swagger-ui.css
|
65
66
|
- app/assets/stylesheets/swagger_ui_engine_2/swagger-ui.css.map
|
66
|
-
- app/assets/stylesheets/swagger_ui_engine_2/swagger-ui.js
|
67
|
-
- app/assets/stylesheets/swagger_ui_engine_2/swagger-ui.js.map
|
68
67
|
- app/controllers/swagger_ui_engine2/application_controller.rb
|
69
68
|
- app/controllers/swagger_ui_engine2/swagger_docs_controller.rb
|
70
69
|
- app/helpers/swagger_ui_engine_2/application_helper.rb
|
@@ -79,7 +78,7 @@ files:
|
|
79
78
|
- lib/swagger_ui_engine_2/engine.rb
|
80
79
|
- lib/swagger_ui_engine_2/version.rb
|
81
80
|
- lib/tasks/swaggerui_tasks.rake
|
82
|
-
homepage:
|
81
|
+
homepage: https://github.com/israelb/swagger_ui_engine_2
|
83
82
|
licenses: []
|
84
83
|
metadata: {}
|
85
84
|
post_install_message:
|
@@ -100,5 +99,5 @@ requirements: []
|
|
100
99
|
rubygems_version: 3.3.8
|
101
100
|
signing_key:
|
102
101
|
specification_version: 4
|
103
|
-
summary:
|
102
|
+
summary: Mountable Rails engine that serves Swagger UI for your API documentation
|
104
103
|
test_files: []
|