rspec_api_documentation-open_api 0.2.2 → 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1dde492d63d90024fe9422a60071ef652d73edc41f25f1d1e853d9a0be6b779d
|
4
|
+
data.tar.gz: 18302d402309fdfbc801674956396382d3361db4e9ad1b72f3a070238fdc5689
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3703c3af28fc4f6d654d1cd7162593c83a41918a9b4964e7349237776a2cdf44d9455af875dd54debdcb082abf41a8fe0a783fba6ee4b178704c1a59d92dc2fd
|
7
|
+
data.tar.gz: 22f5038f469058ac6fb6d542c1a9fb3cabfd6319dc13c464c54effed6150350b85a1fe42b86254d8e9aef6b13600afb0276b91562cdeadbc45236b7c11c57386
|
data/README.md
CHANGED
@@ -1,28 +1,27 @@
|
|
1
1
|
# RspecApiDocumentation::OpenApi
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
TODO: Delete this and the text above, and describe your gem
|
3
|
+
Adds `open_api_json` and `open_api_yaml` output format to `rspec_api_documentation`.
|
4
|
+
This gem is developed to be used at [Cookpad](https://github.com/cookpad/) to create openAPI spec using [`rspec_api_documentation`](https://github.com/zipmark/rspec_api_documentation) gem.
|
6
5
|
|
7
6
|
## Installation
|
8
7
|
|
9
8
|
Add this line to your application's Gemfile:
|
10
9
|
|
11
10
|
```ruby
|
12
|
-
gem 'rspec_api_documentation-open_api'
|
11
|
+
gem 'rspec_api_documentation-open_api', '~>0.2.2'
|
13
12
|
```
|
14
13
|
|
15
14
|
And then execute:
|
16
15
|
|
17
16
|
$ bundle
|
18
17
|
|
19
|
-
Or install it yourself
|
18
|
+
Or install it yourself by:
|
20
19
|
|
21
20
|
$ gem install rspec_api_documentation-open_api
|
22
21
|
|
23
22
|
## Usage
|
24
23
|
|
25
|
-
in *spec/spec_helper.rb*
|
24
|
+
in *spec/spec_helper.rb* add
|
26
25
|
```rb
|
27
26
|
RspecApiDocumentation.configure do |config|
|
28
27
|
config.format = :open_api_json # for json file
|
@@ -35,8 +34,8 @@ RspecApiDocumentation.configure do |config|
|
|
35
34
|
end
|
36
35
|
```
|
37
36
|
|
38
|
-
|
39
|
-
```
|
37
|
+
You can change other default configuration using
|
38
|
+
```rb
|
40
39
|
RspecApiDocumentation.configure do |config| # These are defaults
|
41
40
|
config.open_api = {
|
42
41
|
"info": {
|
@@ -70,7 +69,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
|
|
70
69
|
|
71
70
|
## Contributing
|
72
71
|
|
73
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
72
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/aadityataparia/rspec_api_documentation-open_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
74
73
|
|
75
74
|
## License
|
76
75
|
|
@@ -78,4 +77,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
|
|
78
77
|
|
79
78
|
## Code of Conduct
|
80
79
|
|
81
|
-
Everyone interacting in the RspecApiDocumentation::OpenApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/
|
80
|
+
Everyone interacting in the RspecApiDocumentation::OpenApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aadityataparia/rspec_api_documentation-open_api/blob/master/CODE_OF_CONDUCT.md).
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rspec_api_documentation-open_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.2.
|
4
|
+
version: 0.2.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Aaditya Taparia
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-06-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rspec_api_documentation
|