Skip to content

Commit

Permalink
Updated to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
garywoodfine committed Jun 30, 2022
1 parent 34a64f3 commit 8f7d918
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
@@ -1,2 +1,9 @@
### API Response

A simple elegant library to handle returning responses from Mediator handlers back to REST API handlers.

Often when developing public or internal REST API's it's best to define a standard structure and format of your response objects. The primary reason behind this is two fold, the most important being that you want to simplify the cognitive load required for users to become familiar and use your API. Secondly, it will be easier for your developers to implement various API calls, because they know exactly what is required and they then only have to focus on the business logic implementation.

When implementing a Vertical Slice Architecture and REPR pattern and relying on a Mediatr or another Mediator pattern implmentation pattern you will often need to inform your REST Endpoint of whether a handler action was successful or not and also include sanitised error information to the client.


0 comments on commit 8f7d918

Please sign in to comment.