Skip to content

Let rails users know to use rails_helper #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philsturgeon wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Let rails users know to use rails_helper #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@ Currently supports and validates against OpenAPI 2.0, (see https://github.com/OA
To use Apivore, add the following to your Gemfile:

gem 'apivore'

***WARNING:*** If apivore is listed in the Gemfile _above_ rspec then some issues, specifically `NameError: uninitialized constant RSpec::Mocks`, may arise when trying to run specs.

## Usage

Create a new request spec in spec/requests:
```ruby
# Rails users
require 'rails_helper'
# Everyone else
require 'spec_helper'

RSpec.describe 'the API', type: :apivore, order: :defined do
Expand Down Expand Up @@ -89,7 +93,7 @@ it 'additionally conforms to a custom schema' do
expect(subject).to conform_to("<your custom schema>.json")
end
```
We have included an example [here] (data/custom_schemata/westfield_api_standards.json). The file path to this custom schema is stored in `Apivore::CustomSchemaValidator::WF_SCHEMA`, if you wish to use it.
We have included an example [here] (data/custom_schemata/westfield_api_standards.json). The file path to this custom schema is stored in `Apivore::CustomSchemaValidator::WF_SCHEMA`, if you wish to use it.

Run the tests as part of your normal rspec test suite, e.g., `rake spec:requests`

Expand Down