Commit Graph

60 Commits

Author SHA1 Message Date
Igor Kapkov
56eec5948e Update readme 2020-03-25 16:57:58 +11:00
Greg Myers
63f01962ad
Merge pull request #254 from fooki/master
Parameterize the pattern for test locations
2019-11-17 09:55:54 +00:00
Karl Johansson
4c613af2ba Allow tests to be run without generating docs
By providing the 'document: false' metadata, tests will be run but no swagger
documentation will be generated for the tagged example groups. It works on all
kinds of example groups (responses, verbs, paths etc..).
2019-11-15 16:21:04 +01:00
Karl Johansson
3cd9d38e19 Parameterize the pattern for test locations
This commit allows users to specify search patterns when finding tests to
swaggerize. Omitting the pattern parameter makes rswag search with the default
patterns.

A typical usecase for this feature is when you already have a test suite set up
and you want to use rswag for generating swagger docs rather than high-coverage
testing.

Usage:

rake rswag:specs:swaggerize PATTERN='/your_path..'
2019-11-15 14:51:17 +01:00
Greg Myers
4516ad4b78 Update changelog and tweak readme 2019-11-02 14:52:37 +00:00
Greg Myers
2cf6812ae0
Update README.md 2019-10-19 21:39:24 +01:00
Greg Myers
9722419647
Merge pull request #180 from fishpercolator/default_swaggerize
Add a 'rake rswag' that runs swaggerize as the default
2019-10-17 22:35:50 +01:00
Laura Watson
ea2ed6ca49 Update README 2019-10-17 17:18:27 +01:00
Greg Myers
28245d4dd0
Update README.md 2019-10-17 10:02:24 +01:00
Greg Myers
b1e089af6a
Merge pull request #204 from stefanosx/patch-1
Update README.md
2019-10-16 23:45:53 +01:00
Hayley
dc2ebd94bb update swagger ui to 3.18.2 2019-10-08 16:18:55 +01:00
Greg Myers
0246ff164f Update readme 2019-10-03 23:00:27 +01:00
Greg Myers
7df00dde94
Merge pull request #227 from biow0lf/biow0lf-patch-1
Fix typo
2019-09-30 21:12:11 +01:00
Greg Myers
b7a6b2de8b
Update README.md
Repoint readme links
2019-09-30 21:06:14 +01:00
Igor Zubkov
a00145c1f7
Fix typo 2019-08-20 16:51:27 +03:00
Richard Morris
636cdcd8b3
Merge pull request #92 from seriousbee/add-section-on-formatting-to-RM
Updated Readme.md:
2019-04-08 12:17:05 +01:00
stefanosx
49b5059273
Update README.md
You need to run the generation of rswag:api:install rswag:ui:install in separated lines to work
2019-03-06 12:59:24 +01:00
Rich Daley
bfd3d66ec2 Add a 'rake rswag' that runs swaggerize as the default 2019-01-07 14:17:53 +00:00
Ersin Akinci
d69aa16985
Fix installation instructions for separate gems 2018-10-09 13:44:58 -07:00
Richard Morris
6fc9faab57
Reflect swagger-ui upgrade in readme 2018-07-11 09:01:50 -07:00
Georg Ledermann
00aa08bb22 ⬆️ Upgrade "swagger-ui" to 3.17.3 2018-07-10 14:49:12 +02:00
Richard Morris
ef91e087d3 Update compatibility chart to reflect realty 2018-06-21 23:27:57 -07:00
Georg Ledermann
6b04c72cc9 ⬆️ Upgrade "swagger-ui" to 3.17.1 2018-06-21 09:11:06 +02:00
hoshinotsuyoshi
862ea53cf4 Fix typo in README
Fixed Gemfile example.
2018-05-31 08:54:12 +09:00
Richard Morris
254ade95db
Update README.md 2018-05-24 20:28:17 -07:00
Richard Morris
e52ea0ba69
Update readme 2018-05-21 16:18:30 -07:00
domaindrivendev
9602db34fa Update readme in prep for 2.0.0 release 2018-05-21 16:16:20 -07:00
goutham
799fc70d3a
Add alternative way to load gem for optimization
Most projects don't load rspec in production mode. So makes sense to add it to guide.
2018-05-20 18:22:06 +03:00
Tomasz Czernuszenko
3eda72155a Updated Readme.md:
Added a section on markdown formatting and and clarified some descriptions of API versioning
2017-08-07 14:12:40 +01:00
domaindrivendev
97c2a39cfa Refactor request_factory & response_validator 2017-07-20 23:42:40 -07:00
domaindrivendev
de7ec5f15d Leverage security definitions for headers in example requests 2017-06-26 17:52:00 -07:00
domaindrivendev
1de29136ef Merge pull request #64 from jume-dev/swagger-ui-url-patch
Add proper swagger ui url
2017-06-26 17:39:04 -07:00
domaindrivendev
e03a6d333f Merge branch 'master' into fixdepnotice 2017-06-26 17:26:28 -07:00
Robert Kranz
69c7decce1 Add proper swagger ui url
As this only supports swagger ui 2, the url should link accordingly
2017-06-01 16:01:15 +02:00
Horia Radu
f195c82759 yield entire response instead of only the body 2017-04-29 21:17:53 +03:00
Horia Radu
37f86f6d94 yield entire response instead of only the body 2017-04-29 12:06:57 +03:00
Horia Radu
51c9f4e5e6 Response body value validation
Add the possibility to pass a block to the run_test!
method in order to add expectations on your response
2017-04-28 11:46:52 +03:00
Dante Piombino
233c5cc735 get no deprecation; add some docs 2017-02-16 16:31:45 -05:00
Pavel Bezpalov
98d5b982c4 Add way for examples generation from responses 2017-01-19 11:46:56 +02:00
domaindrivendev
9d4069bcfe A minor readme update 2016-10-19 00:37:06 -07:00
vinhbachsy
0b0acfe4c7 Rename response_examples to examples for consistent DSL
Special handling `examples` invocation with no parameters to avoid
overriding the `examples` method of rspec-core ExampleGroup
2016-10-19 03:04:03 +08:00
vinhbachsy
5ea97a4278 Update README for response headers and examples 2016-10-18 21:46:35 +08:00
Benoit Tigeot
7333fb8993 Change rails rswag UI command to last one 2016-10-12 18:19:56 +02:00
domaindrivendev
1fbce1348c Add travis-ci build status badge 2016-10-11 23:04:41 -07:00
domaindrivendev
06d02fa364 Fix Readme typo 2016-10-11 18:40:11 -07:00
richie
c558098c39 rename to rswag plus major refactor - almost a rewrite 2016-10-11 18:31:12 -07:00
andrew morton
d3d865d6aa Quote the name in the Gemfile
The gem name needs to be a string.
2016-09-07 15:33:48 -06:00
richie
19beb9e34d minor reordering for readability 2016-08-19 15:22:33 -07:00
Garima Singh
4c533caf68 Updating documentation for adding operation_description 2016-08-11 22:14:22 +08:00
richie
7a01babe01 Support mount-specific swagger_root and add swagger_filter setting 2016-06-29 16:11:40 -07:00