Skip to content
Permalink
Browse files

Addressing PR comments.

  • Loading branch information
honzajavorek committed Jun 15, 2016
1 parent 3123ac8 commit 5e5c81bdf4a78b98edf4172e580823ffd6308686
Showing with 8 additions and 6 deletions.
  1. +1 −1 README.md
  2. +1 −1 docs/example.md
  3. +4 −2 docs/how-it-works.md
  4. +1 −1 docs/index.md
  5. +1 −1 docs/quickstart.md
@@ -19,7 +19,7 @@ Dredd reads your API description and step by step validates whether your API
implementation replies with responses as they are described in the
documentation.

## API Description Formats Support
## Supported API Description Formats

- [API Blueprint][]
- [Swagger][] **(experimental)**
@@ -2,7 +2,7 @@

This is an example how to create a simple [Express.js][] API backend application tested with Dredd

## Create an API Description Document
## Create API Description Document

Create a new API description file, for example in the [API Blueprint][] format. Save it as `api-description.apib`

@@ -61,7 +61,7 @@ Dredd automatically generates expectations on HTTP responses based on examples i
### Response Headers Expectations

- All headers specified in the API description must be present in the response.
- Names of headers are validated in case-insensitive way.
- Names of headers are validated in the case-insensitive way.
- Only values of headers significant for content negotiation are validated.
- All other headers values can differ.

@@ -72,7 +72,9 @@ When using [Swagger][], headers are taken from [`response.headers`][]. HTTP head

### Response Body Expectations

By default Dredd validates HTTP response body against [JSON Schema][] inferred from the API description under test. The effective JSON Schema is taken from following places (the order goes from the highest priority to the lowest):
If the HTTP response body is JSON, Dredd validates only its structure. Bodies in any other format are validated as plain text.

To validate the structure Dredd uses [JSON Schema][] inferred from the API description under test. The effective JSON Schema is taken from following places (the order goes from the highest priority to the lowest):

#### API Blueprint

@@ -15,7 +15,7 @@ Dredd reads your API description and step by step validates whether your API
implementation replies with responses as they are described in the
documentation.

## API Description Formats Support
## Supported API Description Formats

- [API Blueprint][]
- [Swagger][] **(experimental)**
@@ -1,7 +1,7 @@
## Quickstart

- If you don't have [Node.js](https://nodejs.org/) installed, you may want to use [NVM](https://github.com/creationix/nvm).
- Create an API description document. In this tutorial, we'll use [API Blueprint](https://apiblueprint.org/) format and the `api-description.apib` filename.
- Create API Description Document. In this tutorial, we'll use [API Blueprint](https://apiblueprint.org/) format and the `api-description.apib` filename.

```
# GET /message

0 comments on commit 5e5c81b

Please sign in to comment.
You can’t perform that action at this time.