Use yaml for declaration language

Author: whytheplatypus

README.md

@@ -7,48 +7,49 @@ A cli and library for declaring what how an API is expected to behave and checki
 
 ## Usage
 
-Describe how you expect an API to behave (currently in TOML)
+Describe how you expect an API to behave (currently in YAML)
 
 Variables can be set from the command-line with `-var` e.g. `-var host=<address>`.
 This can be done multiple times `-var host=<address> -var token=<authToken>`
-[examples/crud.toml](/example/crud.toml)
+[examples/crud.yaml](/example/crud.yaml)
 
 ```
-[create_a_thing]
-name = "Create a thing"
-uri = "{{ .host }}/things/"
-method = "POST"
-body = """
-{
-  "hello": "world",
-  "works": false
-}
-"""
-	[create_a_thing.headers]
-	Authorization = ["Bearer sample_bearer_token"]
+create_a_thing:
+  name: "Create a thing"
+  url: "{{ .host }}/things/"
+  method: "POST"
+  body: |
+          {
+                  "hello": "world",
+                  "works": false
+          }
+  headers:
+    Authorization: ["Bearer sample_bearer_token"]
 ```
 State what you expect the API to do with this input.
 ```
-	[create_a_thing.assert]
-		[create_a_thing.assert.code]
-		code = 200
+  assert:
+    response:
+      code: 200
+      body: '{"id": 0}'
+      headers:
+        Content-Type: ["application/json"]
 ```
 
 Steps from the same file are run in order and results from previous steps can be used
 e.g. `json .create_a_thing "id"` returns the value from the `id` key of the json response from the `create_a_thing` step.
 ```
-[read_a_thing]
-name = "Read a thing"
-uri = "{{ .host }}/things/${ json .create_a_thing `id` }"
-method = "GET"
-	[read_a_thing.headers]
-	Authorization = ["Bearer sample_bearer_token"]
-
-	[read_a_thing.assert]
-		[read_a_thing.assert.code]
-		code = 200
-		[read_a_thing.assert.jsonschema]
-		ref = "examples/thing.json"
+read_a_thing:
+  name: "Read a thing"
+  url: "{{ .host }}/things/${ json .create_a_thing `id` }"
+  method: "GET"
+  headers:
+    Authorization: ["Bearer sample_bearer_token"]
+  assert:
+    response:
+      code: 200
+    jsonschema:
+      ref: "examples/thing.json"
 ```
 
 For a full example run you can pull down the repository and use the server used for tests to experiment.
@@ -64,7 +65,7 @@ This will output the port the test server is running on.
 
 In another terminal run the example hypothesis.
 ```
-go run . -v -var host=<address from go test> examples/crud.toml
+go run . -v -var host=<address from go test> examples/crud.yaml
 ```
-Try modifying [examples/crud.toml](/examples/crud.toml) to make the run fail.
+Try modifying [examples/crud.yaml](/examples/crud.yaml) to make the run fail.