File tree 2 files changed +6
-6
lines changed
2 files changed +6
-6
lines changed Original file line number Diff line number Diff line change 4
4
[ ![ Code Climate] ( https://codeclimate.com/github/drewish/rspec-rails-swagger/badges/gpa.svg )] ( https://codeclimate.com/github/drewish/rspec-rails-swagger )
5
5
6
6
This 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.
10
10
11
11
The design of this was heavily influenced by the awesome [ swagger_rails gem] ( https://github.com/domaindrivendev/swagger_rails ) .
12
12
@@ -52,9 +52,9 @@ and some default requests filled in. With the structure in place you should only
52
52
need to add ` before ` calls to create records and then update the ` let ` s to
53
53
return the appropriate values.
54
54
55
- ## Generate the JSON
55
+ ## Generate the JSON or YAML
56
56
57
- To create the Swagger JSON files use the rake task:
57
+ To create the Swagger files use the rake task:
58
58
59
59
```
60
60
bundle exec rake swagger
Original file line number Diff line number Diff line change @@ -3,7 +3,7 @@ module Rails
3
3
# Version information for RSpec Swagger.
4
4
module Swagger
5
5
module Version
6
- STRING = '0.1.4 '
6
+ STRING = '0.1.5 '
7
7
end
8
8
end
9
9
end
You can’t perform that action at this time.
0 commit comments