chore(auth): Add documentation and specs

This commit is contained in:
Austin Kabiru
2018-11-30 14:23:11 +03:00
parent b0712418a3
commit 875bbfa04b
3 changed files with 79 additions and 2 deletions

View File

@@ -44,9 +44,9 @@ Once you have an API that can describe itself in Swagger, you've opened the trea
```ruby
rails g rswag:install
```
Or run the install generators for each package separately if you installed Rswag as separate gems, as indicated above:
```ruby
rails g rswag:api:install rswag:ui:install
RAILS_ENV=test rails g rswag:specs:install
@@ -477,6 +477,17 @@ Rswag::Ui.configure do |c|
end
```
### Enable Simple Basic Auth for swagger-ui
You can also update the _rswag-ui.rb_ initializer, installed with rswag-ui to specify a username and password should you want to keep your documentation private.
```ruby
Rswag::Ui.configure do |c|
c.basic_auth_enabled = true
c.basic_auth_credentials 'username', 'password'
end
```
### Route Prefix for the swagger-ui ###
Similar to rswag-api, you can customize the swagger-ui path by changing it's mount prefix in _routes.rb_: