add json example from http request

I was looking for an example of how to do this, but I didn't find
anything in the documentation. This is a simple examle in the `json`
resource that returns a JSON blob back from an `http` request to a
"`/health`" endpoint.

Signed-off-by: Joshua Timberman <joshua@chef.io>
This commit is contained in:
jtimberman 2019-02-21 10:23:52 -07:00
parent 46415dfbff
commit d2d4c9605f

View file

@ -82,6 +82,24 @@ The `name` matcher tests the value of the filename as read from a JSON file vers
<br>
### Test JSON output from an HTTP API
Our example API has a `/health` endpoint, which looks like this:
{
"service": {
"port": 3000,
"status": "ok"
}
}
Example test:
describe json(content: http('http://localhost:3000/health').body) do
its(['service', 'port']) { should eq 3000 }
its(['service', 'status']) { should eq 'ok' }
end
## Matchers
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).