Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
R
rspec-rails-swagger
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
open-source
rspec-rails-swagger
Commits
c6b2d183
Commit
c6b2d183
authored
Sep 25, 2016
by
andrew morton
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
More docs
parent
c43e589c
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
7 deletions
+8
-7
README.md
README.md
+8
-7
No files found.
README.md
View file @
c6b2d183
...
...
@@ -13,17 +13,18 @@ The design of this was heavily influenced by the awesome [swagger_rails gem](htt
## Setup
-
Add the gem to your Rails app's
`Gemfile`
:
```
```
rb
group
:development
,
:test
do
gem
'rspec-swagger'
end
```
-
If you don't already have a
`spec/rails_helper.rb`
file run:
```
```
shell
rails generate rspec:install
```
-
Create
`spec/swagger_helper.rb`
file (eventually this will become a generator):
```
-
Create
`spec/swagger_helper.rb`
file (eventually
[
this will become a
generator](https://github.com/drewish/rspec-swagger/issues/3)):
```
rb
require
'rspec/swagger'
require
'rails_helper'
...
...
@@ -54,7 +55,7 @@ end
## Generate the docs
Eventually
this will become a rake task
:
Eventually
[
this will become a rake task
](
https://github.com/drewish/rspec-swagger/issues/2
)
:
```
bundle exec rspec -f RSpec::Swagger::Formatter --order defined -t swagger_object
```
...
...
@@ -62,13 +63,13 @@ bundle exec rspec -f RSpec::Swagger::Formatter --order defined -t swagger_object
## Running tests
The
`make_site.sh`
script will create a test site for a specific version of
Rails:
Rails
and run the tests
:
```
RAILS_VERSION=4.2.0
./make_site.sh
```
R
e-run the tests:
Once the test site is created you can just r
e-run the tests:
```
bundle exec rspec
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment