ditkrg/rswag
4
0
Fork 0
mirror of https://github.com/ditkrg/rswag.git synced 2026-01-22 22:06:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme in prep for 2.0.0 release

Browse Source
This commit is contained in:
domaindrivendev 2018-05-21 16:16:20 -07:00
parent d4b6848fa5
commit 9602db34fa
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -10,6 +10,14 @@ And that's not all ...
Once you have an API that can describe itself in Swagger, you've opened the treasure chest of Swagger-based tools including a client generator that can be targeted to a wide range of popular platforms. See [swagger-codegen](https://github.com/swagger-api/swagger-codegen) for more details.
## Compatibility ##
|Rswag Version|Swagger (OpenAPI) Spec.|swagger-ui|
|----------|----------|----------|
|[master](https://github.com/domaindrivendev/rswag/tree/master)|2.0|3.13.2|
|[2.0.0](https://github.com/domaindrivendev/rswag/tree/2.0.0)|2.0|3.13.2|
|[1.6.0](https://github.com/domaindrivendev/rswag/tree/1.6.0)|2.0|2.2.5|
## Getting Started ##
1. Add this line to your applications _Gemfile_:
@ -17,6 +25,7 @@ Once you have an API that can describe itself in Swagger, you've opened the trea
```ruby
gem 'rswag'
```
or if you like to avoid loading rspec in other bundler groups.
```ruby
@ -30,7 +39,6 @@ Once you have an API that can describe itself in Swagger, you've opened the trea
end
```
2. Run the install generator
```ruby
@ -485,3 +493,13 @@ rails g rswag:ui:custom
```
This will add a local version that you can modify at _app/views/rswag/ui/home/index.html.erb_
### Publish UI Assets with "assets:precompile:
Rswag ships with an embedded version of the [swagger-ui](https://github.com/swagger-api/swagger-ui), which is a static collection of JavaScript and CSS files. These assets are served by the rswag-ui middleware. However, for optimal performance you may want to serve them directly from your web server (e.g. Apache or NGINX). To do this, you'll need to copy them to the web server root. This is the "public" folder in a typical Rails application.
```
bundle exec rake rswag:ui:copy_assets[public/api-docs]
```
__NOTE:__: The provided subfolder MUST correspond to the UI mount prefix - "api-docs" by default.