swagger_ui_engine_2 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2929291e3d0d75d2ceedefa94acfdaf5ff1249babd804206bc0532328fc23a95
-  data.tar.gz: 6f70517cdf51f4506ee7b4a90573d1f9de775aba7af339cdfb1f6caef71e8a50
+  metadata.gz: 51014a3f4a48468f34c5d2b365b937dfd5e73ca13b49b687d912dc287f4a5ee4
+  data.tar.gz: 68c14c5012785eeceb4f32155a677a7d490badfc8e20514607612415bb5b33ca
 SHA512:
-  metadata.gz: 9f0e6c065fd01bd3ad27fd4232366877c82737f321d6929d4cf7355c09f8dae75033da7b11477247954191a1750000e81849e749a71514ad218e7d882064de1e
-  data.tar.gz: 9545e7984acc4564b1b45752717478bed8523e40278d16e872eff47ec6631ea67ac254666a1d5cc4f077bdcec4579387ea9d3b10a9cc718127df59ab2f606885
+  metadata.gz: 9b8425a07528b24c59cb12c8fc1c6fdcc8c32ac553956561c53f79b2483b95e6ea0126cb5e786cd89eba3b08f3b1b8b01d091ca6b2e07bdb89be3c4161573a53
+  data.tar.gz: f5e6a22042a231a77edd633f10a8d2b094d26866ceb741482c1ab57fb0795c98b254bce34f0d5ef10833fb896d87c6327aa0896a333fc65b4d3d4285fa6f0479

data/README.md

@@ -1,14 +1,20 @@
 # SwaggerUiEngine2
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+Include [swagger-ui](https://github.com/swagger-api/swagger-ui) as Rails engine and document your API with simple YAML files.
+
+This gem is a fork of 'swagger_ui_engine'. Because it is no longer maintainable anymore.
+
+## Versions
+
+Swagger UI version | Rails version
+------------------ | ----------------
+4.6.2              | >= 6
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "swaggerui"
+gem 'swagger_ui_engine_2'
 ```
 
 And then execute:
@@ -16,13 +22,51 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install swaggerui
+## Usage
+
+### Mount
+
+Add to your `config/routes.rb`
+
+```
+mount SwaggerUiEngine2::Engine, at: "/api_docs"
+```
+
+You can place this route under `admin_constraint` or other restricted path, or configure basic HTTP authentication.
+
+#### Basic HTTP auth
+
+Set admin username and password in an initializer:
+
+```
+# config/initializers/swagger_ui_engine.rb
+
+SwaggerUiEngine2.configure do |config|
+  config.admin_username = ENV['ADMIN_USERNAME']
+  config.admin_password = ENV['ADMIN_PASSWORD']
+end
+```
+
+#### Single API documentation
+
+You can define your main documentation url in a hash value (same way as in the versioned documentations) or pass single string with the url:
+
+```
+# config/initializers/swagger_ui_engine.rb
+
+SwaggerUiEngine2.configure do |config|
+  config.swagger_url = 'open_api.json'
+end
 ```
 
-## Contributing
-Contribution directions go here.
+### Configure
+Config Name | Swagger parameter name | Description
+--- | --- | ---
+config.swagger_url | url | The URL pointing to API definition (normally swagger.json or swagger.yaml)
+config.doc_expansion | docExpansion | Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing).
+config.model_rendering | defaultModelRendering | Controls how the model is shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links.)
+config.layout | layout | The name of a component available via the plugin system to use as the top-level layout for Swagger UI. It can be 'StandaloneLayout' (shows the url) and 'BaseLayout' (hides the url) |
+config.validator_enabled | validatorUrl | Enables documentation validator.  Defaults to `false` (`validatorUrl: 'null'`).
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).