https://github.com/nunogois/net5-webapi

.NET 5.0 Docker-ready C# REST API example using JWT authentication, Swagger, Newtonsoft JSON, and Dapper with SQL Server.
https://github.com/nunogois/net5-webapi

cross-platform csharp dapper docker jwt-authentication net5 netcore-webapi newtonsoft-json rest-api sql-server swagger

Last synced: 3 months ago
JSON representation

.NET 5.0 Docker-ready C# REST API example using JWT authentication, Swagger, Newtonsoft JSON, and Dapper with SQL Server.

• Host: GitHub
• URL: https://github.com/nunogois/net5-webapi
• Owner: nunogois
• License: mit
• Created: 2021-02-11T02:08:53.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-11T14:08:00.000Z (almost 4 years ago)
• Last Synced: 2024-04-16T14:13:34.902Z (9 months ago)
• Topics: cross-platform, csharp, dapper, docker, jwt-authentication, net5, netcore-webapi, newtonsoft-json, rest-api, sql-server, swagger
• Language: C#
• Homepage:
• Size: 85 KB
• Stars: 13
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# net5-webapi

.NET 5.0 Docker-ready C# REST API example using JWT authentication, Swagger, Newtonsoft JSON, and Dapper with SQL Server.

![net5-webapi](https://github.com/nunogois/net5-webapi/blob/master/net5-webapi-thumbnail.png)

![.NET 5.0](https://img.shields.io/badge/-.NET_5.0-141321?style=for-the-badge&logo=.net&logoColor=ba46d8) 

![C#](https://img.shields.io/badge/-C%23-141321?style=for-the-badge&logo=c-sharp&logoColor=239120) 

![Docker-ready](https://img.shields.io/badge/-Docker--ready-141321?style=for-the-badge&logo=Docker&logoColor=2496ED) 

![Swagger](https://img.shields.io/badge/-Swagger-141321?style=for-the-badge&logo=Swagger&logoColor=85EA2D) 

![JWT Authentication](https://img.shields.io/badge/-JWT_Authentication-141321?style=for-the-badge&logo=JSON-Web-Tokens&logoColor=ffffff) 

![Dapper -> SQL Server](https://img.shields.io/badge/-Dapper_-->_SQL%20Server-141321?style=for-the-badge&logo=Microsoft-SQL-Server&logoColor=CC2927) 

## Swagger

When you first run this project on dev, you should be greeted by [Swagger](https://swagger.io/), 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.

### Swagger - Authorization

After logging in with `POST /api/Auth/Login` you will receive a token ([JWT](https://jwt.io/)) 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**.

## DBConnection (Dapper -> SQL Server)

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](https://github.com/StackExchange/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](https://www.microsoft.com/sql-server/sql-server-2019?rtc=1) queries I'm using are just examples, adapt to your own database schema and needs.

## JWT Authentication

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;

## Docker

Since this is a [.NET 5.0](https://docs.microsoft.com/en-us/dotnet/core/dotnet-five) 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.

## Controllers

### Auth

 - **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.

 

### Notes

 - **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.

 

## Engines

### DBEngine

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.

### CryptoEngine

Use CryptoEngine to execute cryptography methods. This is basically a wrapper for [CryptoHelper](https://github.com/henkmollema/CryptoHelper). 

Check ICryptoEngine for more information on the methods.