README.md in rack-schema-0.5.0 vs README.md in rack-schema-0.6.0
- old
+ new
@@ -1,7 +1,13 @@
# Rack::Schema
+[](http://badge.fury.io/rb/rack-schema)
+[](https://travis-ci.org/pd/rack-schema)
+[](https://gemnasium.com/pd/rack-schema)
+[](https://codeclimate.com/github/pd/rack-schema)
+[](https://coveralls.io/r/pd/rack-schema?branch=master)
+
Validate your application's responses against [JSON Schemas][json-schema].
## Installation
Add this line to your application's Gemfile:
@@ -63,28 +69,43 @@
# Assert that '#/teams' is an array of valid teams, and '#/score' is a valid score.
Link: <http://example.com/schemas/team>; rel="describedby"; anchor="#/teams"; collection="collection",
<http://example.com/schemas/score>; rel="describedby"; anchor="#/score"
## Configuration
+
+### Validate Schemas
By default, `rack-schema` will also instruct the validator to validate
your schema itself *as* a schema. To disable that behavior:
~~~~ruby
use Rack::Schema, validate_schemas: false
~~~~
+### Swallow Links
If you are running the `rack-schema` response validator in a
production environment -- which you probably *shouldn't* be doing --
-you don't want to actually expose the `describedby` link header
+and you don't want to actually expose the `describedby` link header
entries to the world, you can tell `rack-schema` to remove them from
the responses after using them:
~~~~ruby
use Rack::Schema, swallow_links: true
~~~~
With `swallow_links` on, only the *describedby* links will be removed;
your pagination or similar links will not be disturbed.
+
+### Error Handler
+By default, `rack-schema` will raise a `ValidationError` if it encounters
+any errors in your response JSON. If that's not your bag, you can define
+a different error handler by providing a block:
+
+~~~ruby
+use Rack::Schema do |errors, env, (status, headers, body)|
+ # Preferably, use a less useless error message.
+ my_logger.warn("JSON response did not match schema!")
+end
+~~~
## Potential Features?
1. Validate incoming JSON bodies, but I just don't need that right now.