.NET 5.0 Docker-ready C# REST API example using JWT authentication, Swagger, Newtonsoft JSON, and Dapper with SQL Server.
When you first run this project on dev, you should be greeted by Swagger, listing all the available endpoints automatically and allowing you to try them.
This assumes the methods are working properly, so you'll need to setup your own JWT configuration, database connection and queries first. Check below for more information.
After logging in with POST /api/Auth/Login you will receive a token (JWT) along with session info.
You can use that token to authenticate in Swagger. Simply click on Authorize on the top right corner and enter Bearer *your_token* in the dialog. If the token is valid, you should be able to request authenticated routes like the ones in Notes.
I'm using DBEngine as an example interface for your preferred database. Feel free to use Entity Framework if you prefer, for example. I like using Dapper because I find it extremely fast and flexible.
The connection string is currently being fetched from ConnectionStrings.DBConnection in appsettings.json.
The SQL Server queries I'm using are just examples, adapt to your own database schema and needs.
JWT configuration is currently being fetched from JWT in appsettings.json.
- Issuer - Add your JWT issuer;
- Key - Add your JWT key;
- ExpireMinutes - Add your JWT expiration minutes - evaluate accordingly, it might make sense to automatically refresh the JWT in prod;
Since this is a .NET 5.0 project, it is cross-platform and this means it can also be easily containerized in Docker. Obviously, this doesn't mean you need to run this project in Docker, however the option is available. If you're using Visual Studio, you can easily switch between debug profiles on the debug dropdown.
I suggest exploring Dockerfile and launchSettings.json for more information.
- POST /api/Auth/Login - Login with username and password. No previous authorization required.
- POST /api/Auth/Register - Register with username, email, name and password. No previous authorization required.
- GET /api/Auth/Session - Returns the session data for this user.
- GET /api/Notes - Returns all the Notes for this user.
- POST /api/Notes - Creates a new Note for this user.
- GET /api/Notes/{id} - Returns a specific Note (id) for this user.
- PUT /api/Notes/{id} - Updates a specific Note (id) for this user.
- DELETE /api/Notes/{id} - Deletes a specific Note (id) for this user.
Use DBEngine as a template to your own database interface. In my case: Dapper and SQL Server.
Check IDBEngine for more information on the methods.
Use CryptoEngine to execute cryptography methods. This is basically a wrapper for CryptoHelper.
Check ICryptoEngine for more information on the methods.