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

More readme typo fixes

Browse Source
This commit is contained in:
domaindrivendev 2016-04-15 10:13:38 -07:00
parent 0a3c7abc51
commit 06ec343c89
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -74,9 +74,9 @@ There's two separate parts to swagger rails:
1. Tooling to easily generate swagger descriptions directly from your API tests/specs 1. Tooling to easily generate swagger descriptions directly from your API tests/specs
2. Rails middleware to auto-magically serve a swagger-ui that's powered by those descriptions 2. Rails middleware to auto-magically serve a swagger-ui that's powered by those descriptions
The tooling is designed to fit seamlessly into your development workflow, with the swagger docs and UI being a by-product that you get for free ... well almost free :) You'll need to use the provided rspec DSL, but it's an intuitive syntax (based on the swagger-spec) and, IMO, a very succint and expressive way to write api/integration tests. The tooling is designed to fit seamlessly into your development workflow, with the swagger docs and UI being a by-product that you get for free ... well almost free :) You'll need to use the provided rspec DSL. But, it's an intuitive syntax (based on the [swagger-spec](http://swagger.io/specification/)) and, IMO, a very succint and expressive way to write api/integration tests.
Once you've generated the swagger files, the functionality to serve up them up, along with the swagger-ui, is provided as a Rails Engine. After running the install generator, you'll see the following line added to _routes.rb_ Once you've generated the swagger files, the functionality to serve them up, along with the swagger-ui, is provided as a Rails Engine. After running the install generator, you'll see the following line added to _routes.rb_
```ruby ```ruby
mount SwaggerRails::Engine => '/api-docs' mount SwaggerRails::Engine => '/api-docs'
@ -107,18 +107,18 @@ By default, the generator will create all operation descriptions in a single swa
And then tagging your spec's with the target swagger_doc: And then tagging your spec's with the target swagger_doc:
```ruby ```ruby
require 'rails_helper' require 'rails_helper'
require 'swagger_rails/rspec/adapter' require 'swagger_rails/rspec/adapter'
describe 'Blogs API V2', swagger_doc: 'v2/swagger.json' do describe 'Blogs API V2', swagger_doc: 'v2/swagger.json' do
extend SwaggerRails::RSpec::Adapter extend SwaggerRails::RSpec::Adapter
path '/blogs' do path '/blogs' do
... ...
end
end end
``` end
```
Then, when you run the generator and spin up the swagger-ui, you'll see a select box in the top right allowing your audience to switch between the different API versions. Then, when you run the generator and spin up the swagger-ui, you'll see a select box in the top right allowing your audience to switch between the different API versions.