File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 44[ ![ Code Climate] ( https://codeclimate.com/github/drewish/rspec-rails-swagger/badges/gpa.svg )] ( https://codeclimate.com/github/drewish/rspec-rails-swagger )
55
66This gem helps you generate Swagger docs by using RSpec to document the paths.
7- You execute a command to run the tests and generate the ` .json ` output. Running
8- the tests ensures that your API and docs are in agreement, and generates output
9- that can be used as examples.
7+ You execute a command to run the tests and generate the ` .yaml ` or ` . json` output.
8+ Running the tests ensures that your API and docs are in agreement, and generates
9+ output that can be saved as response examples.
1010
1111The design of this was heavily influenced by the awesome [ swagger_rails gem] ( https://github.com/domaindrivendev/swagger_rails ) .
1212
@@ -52,9 +52,9 @@ and some default requests filled in. With the structure in place you should only
5252need to add ` before ` calls to create records and then update the ` let ` s to
5353return the appropriate values.
5454
55- ## Generate the JSON
55+ ## Generate the JSON or YAML
5656
57- To create the Swagger JSON files use the rake task:
57+ To create the Swagger files use the rake task:
5858
5959```
6060bundle exec rake swagger
Original file line number Diff line number Diff line change @@ -3,7 +3,7 @@ module Rails
33 # Version information for RSpec Swagger.
44 module Swagger
55 module Version
6- STRING = '0.1.4 '
6+ STRING = '0.1.5 '
77 end
88 end
99 end
You can’t perform that action at this time.
0 commit comments