WebService is a simple REST API implementation written in ASP.NET Core that allows for the basic CRUD operation via a REST web service. The main purpose is the investigate and demonstrate the best practices for implementing a caching middleware. The use of PATCH to do a partial update will also be demonstrated.
The solution is comprised of 3 components:
- WebService.Api is a REST API that allows for client applications to interact with the Web API. Provides simple data access.
- WebService Tests is a set of unit tests and integration tests to automate testing of the system components.
Additional components:
- Simple in memory database using .NET DataSet and DataTable classes to store all the data used for the system.
#Tech Stack
- .NET Core 3.1 (for Web API)
- .NET Standard 2.1 (for libraries)
- .NET DataTable (for database)
- Swagger (API documentation)
- Serilog (logging)
- Docker (containers)
Demonstrate how to implement caching middleware for an ASP.NET Core REST API application. Demonstrate how to use PATCH to do partial updates via RESTful service.
A solution called WebService will be developed to perform the required operations.
- Create a simple REST API.
- Implement caching middleware.
- Implement partial update (PATCH).
- Use Docker.
Note: See below for links to code repositories.
- [RunLog Project] (https://github.com/users/MrJohnB/projects/2)
- [RunLog Repository] (https://github.com/MrJohnB/WebService)
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
- Installation process
- Software dependencies
- Latest releases
- API references
- Build the solution in Visual Studio 2019 and run. TODO: Describe and show how to build your code and run the tests.
- [RunLog Repository] (https://github.com) TODO: Explain how other users and developers can contribute to make your code better.
If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files: