grim/resticide

Add a bunch of stuff to the readme
develop tip
2016-07-09, Gary Kramlich
f8bc0c4813a9
Parents 32bc94f303e2
Children
Add a bunch of stuff to the readme
1 files changed, 37 insertions(+), 1 deletions(-)
  • +37 -1
    README.md
    • --- a/README.md Sat Jul 09 15:48:36 2016 -0500
    +++ b/README.md Sat Jul 09 16:04:51 2016 -0500
    @@ -1,1 +1,37 @@
    -Resticide is a tool for testing REST API's
    +#Resticide
    +
    +Resticide is a black box testing tool for REST API's. You define your tests
    +and away it runs.
    +
    +# Example
    +
    +Let's say we have an endpoint that is supposed to return a 200 we would write
    +the following test and save it as 200.json
    +
    +```
    +{
    + "name": "200 test",
    + "request": {
    + "path": "/get",
    + "method": "GET",
    + "response": {
    + "statuscode": 200
    + }
    + }
    +}
    +```
    +
    +We can now run the test with
    +
    +```
    +resticide --path=. --host=https://httpbin.org/
    +```
    +
    +And you'll see the following output
    +
    +```
    +200 test passed 294.054033ms
    +
    +----------------------------------------
    +1 tests, 1 passed, 0 failed
    +```