Merge pull request #79 from ivaylokenov/development

Version 0.4

Author: ivaylokenov

documentation/README.md

@@ -3,6 +3,25 @@
 
 ## Full list of available features
 
+### Table of contents
+
+ - [Controller instantiation](#controller-instantiation)
+ - [Authenticated user](#authenticated-user)
+ - [Calling actions](#calling-actions)
+ - [Model state validation](#model-state-validation)
+ - [Catching thrown exceptions](#catching-thrown-exceptions)
+ - [Generic result](#generic-result)
+ - [Any result](#any-result)
+ - [Ok result](#ok-result)
+ - [Unauthorized result](#unauthorized-result)
+ - [BadRequest result](#badrequest-result)
+ - [JSON result](#json-result)
+ - [StatusCode result](#statuscode-result)
+ - [NotFound result](#notfound-result)
+ - [Conflict result](#conflict-result)
+ - [EmptyContent (void) result](#emptycontent-void-result)
+ - [AndProvide... methods](#andprovide-methods)
+
 ### Controller instantiation
 
 You have a couple of options from which you can setup the controller you want to test. The framework gives you static `MyWebApi` class from which the test builder starts:
@@ -42,6 +61,8 @@ MyWebApi
 	.Controller(myWebApiControllerInstance);
 ```
 
+[To top](#table-of-contents)
+
 ### Authenticated user
 
 ```c#
@@ -68,6 +89,8 @@ MyWebApi
 		.InRoles("Moderator", "Administrator")); // or InRole("Moderator")
 ```
 
+[To top](#table-of-contents)
+
 ### Calling actions
 
 You can call any action using lambda expression. All parameter values will be resolved and model state validation will be performed on them:
@@ -89,6 +112,8 @@ MyWebApi
 	.CallingAsync(c => c.SomeActionAsync());
 ```
 
+[To top](#table-of-contents)
+
 ### Model state validation
 
 You can test whether model state is valid/invalid or contains any specific error:
@@ -154,6 +179,8 @@ MyWebApi
 	.ContainingModelStateErrorFor(m => m.SecondProperty).Containing("ror mes"); 
 ```
 
+[To top](#table-of-contents)
+
 ### Catching thrown exceptions
 
 You can test whether action throws exception:
@@ -210,6 +237,8 @@ MyWebApi
 	.WithStatusCode(HttpStatusCode.NotFound);
 ```
 
+[To top](#table-of-contents)
+
 ### Action results
 
 You can test for specific return values or the default IHttpActionResult types:
@@ -275,6 +304,8 @@ MyWebApi
 	.ShouldReturn();
 ```
 
+[To top](#table-of-contents)
+
 #### Ok result
 
 ```c#
@@ -346,6 +377,8 @@ MyWebApi
 	.ContainingNoModelStateErrorFor(m => m.AnotherProperty);
 ```
 
+[To top](#table-of-contents)
+
 #### Unauthorized result
 
 ```c#
@@ -448,6 +481,8 @@ MyWebApi
 				.ContainingHeader(header => header.WithScheme(AuthenticationScheme.Basic)));
 ```
 
+[To top](#table-of-contents)
+
 #### BadRequest result
 
 ```c#
@@ -534,6 +569,8 @@ MyWebApi
 		.ContainingNoModelStateErrorFor(m => m.NonRequiredString);
 ```
 
+[To top](#table-of-contents)
+
 #### JSON result
 ```c#
 // tests whether the action returns JSON
@@ -587,6 +624,8 @@ MyWebApi
 		.WithConstructorHandling(ConstructorHandling.Default));
 ```
 
+[To top](#table-of-contents)
+
 #### StatusCode result
 
 ```c#
@@ -616,6 +655,8 @@ MyWebApi
 	.NotFound();
 ```
 
+[To top](#table-of-contents)
+
 #### Conflict result
 ```c#
 // tests whether the action returns ConflictResult
@@ -626,6 +667,8 @@ MyWebApi
 	.Conflict();
 ```
 
+[To top](#table-of-contents)
+
 #### InternalServerError result
 ```c#
 // tests whether the action returns 
@@ -704,6 +747,8 @@ MyWebApi
 	.WithMessage().Containing("n m");
 ```
 
+[To top](#table-of-contents)
+
 #### EmptyContent (void) result
 ```c#
 // tests whether the action does not return anything (204 No Content)
@@ -714,6 +759,8 @@ MyWebApi
 	.ShouldReturnEmpty();
 ```
 
+[To top](#table-of-contents)
+
 ### AndProvide... methods
 
 You can get controller, action, action result and response model information where applicable by using AndProvide... methods.
@@ -766,4 +813,6 @@ MyWebApi
 	.ShouldThrow()
 	.Exception()
 	.AndProvideTheCaughtException();
-```
+```
+
+[To top](#table-of-contents)