example requests to readme

Author: jaredcnance

README.md

@@ -23,6 +23,84 @@ services.AddJsonApi(config => {
 app.UseJsonApi();
 ```
 
+## Example Requests
+
+### GET TodoItems
+
+Request:
+
+```
+curl -X GET 
+  -H "Content-Type: application/vnd.api+json" 
+  "http://localhost:5000/api/v1/todoItems/"
+```
+
+Response:
+
+```
+{
+  "links": {
+    "self": "http://localhost:5000/api/v1/todoItems/"
+  },
+  "data": [
+    {
+      "type": "todoItems",
+      "id": "2",
+      "attributes": {
+        "name": "Something To Do"
+      },
+      "relationships": {
+        "owner": {
+          "self": "http://localhost:5000/api/v1/todoItems/2/relationships/owner",
+          "related": "http://localhost:5000/api/v1/todoItems/2/owner"
+        }
+      },
+      "links": {
+        "self": "http://localhost:5000/api/v1/todoItems/2"
+      }
+    }
+  ]
+}
+```
+
+### Get People/{id}
+Request:
+
+```
+curl -X GET 
+  -H "Content-Type: application/vnd.api+json" 
+  "http://localhost:5000/api/v1/people/1"
+```
+
+Response:
+
+```
+{
+  "links": {
+    "self": "http://localhost:5000/api/v1/people/1"
+  },
+  "data": {
+    "type": "people",
+    "id": "1",
+    "attributes": {
+      "name": "Captain Obvious"
+    },
+    "relationships": {
+      "todoItems": {
+        "self": "http://localhost:5000/api/v1/people/1/relationships/todoItems",
+        "related": "http://localhost:5000/api/v1/people/1/todoItems"
+      }
+    },
+    "links": {
+      "self": "http://localhost:5000/api/v1/people/1"
+    }
+  }
+}
+```
+
+## References
+[JsonApi Specification](http://jsonapi.org/)
+
 ## Current Assumptions
 
 - Using Entity Framework