ASP.NET Core Web API with Dapper, PostgreSQL, JWT Authentication and Docker Support

This project demonstrates how to create an ASP.NET Core 8 Web API for user registration and login using JWT (JSON Web Tokens) for authentication. It uses Dapper for database interaction, PostgreSQL as the database and Docker for containerization. Swagger is also integrated for easy API testing.

Features

• JWT Authentication: Secure user authentication with JWT tokens.
• User Registration and Login: Users can register and log in to receive JWT tokens.
• HttpOnly Cookies: JWT tokens are stored in secure HttpOnly cookies for better security.
• Dapper: Lightweight ORM for database access with PostgreSQL.
• PostgreSQL: Database management system.
• Swagger: API documentation and testing interface.
• Docker Support: Easily containerize and run the application using Docker.

Prerequisites

• .NET 8 SDK
• PostgreSQL
• Dapper
• Npgsql
• Docker

Getting Started

1. Clone the Repository

git clone https://github.com/galaridor/dotnet8-webapi-auth.git

2. Install Dependencies

Ensure you have the required NuGet packages installed:

dotnet add package Dapper
dotnet add package Npgsql
dotnet add package Microsoft.AspNetCore.Authentication.JwtBearer
dotnet add package Swashbuckle.AspNetCore
dotnet add package FluentValidation

3. Set up PostgreSQL Database

1. Create a PostgreSQL database:

   CREATE DATABASE jwt_demo;

Upon application startup, the database initializer will ensure the Users table is created (if it doesn't exist). A default admin user is created with the following credentials:

Username: Administrator
Password: Administrator1!

2. Update the connection string in appsettings.json with your PostgreSQL credentials:

   {
     "ConnectionStrings": {
       "DefaultConnection": "Host=localhost;Database=jwt_demo;Username=youruser;Password=yourpassword"
     }
   }

4. Update JWT Settings

Ensure your JWT key in appsettings.json is at least 32 characters long:

{
  "Jwt": {
    "Key": "YourSuperSecretKeyAtLeast32Characters",
    "Issuer": "YourAppIssuer",
    "Audience": "YourAppAudience",
    "TokenExpiryMinutes": 30
  }
}

5. Run the Application

Use the following command to run the application:

dotnet run

The API will be running at https://localhost:<port>.

6. Test the API with Swagger

Swagger UI is available at https://localhost:<port>/swagger. You can use it to test the following endpoints:

POST /api/auth/register

• Register a new user.
• Request Body:

  {
    "username": "string",
    "password": "string"
  }

POST /api/auth/login

• Log in a registered user and receive a JWT token stored in a HttpOnly cookie.
• Request Body:

  {
    "username": "string",
    "password": "string"
  }

Upon successful login, you will receive a JWT token in an HttpOnly cookie. Use this token to access protected routes by making requests to the API without needing to handle the token directly in the client.

Docker Support

You can run this application in a Docker container for easier deployment and management.

1. Build Docker Image

docker build -t your-api-image .

2. Run the Docker Container

docker run -p 8080:8080 your-api-image

This will expose the application on http://localhost:8080.

3. Access Swagger UI

Navigate to http://localhost:8080/swagger to test the API.

Project Structure

• Controllers/ - Contains the AuthController for handling registration and login.
• Database/ - Contains DatabaseInitializer and DbConnectionFactory for initializing the databse.
• Extensions/ - Contains ServiceExtensions to register Authentication service and SwaggerExtensions to register swagger.
• Models/ - Contains the User, RegisterDto, and LoginDto models.
• Services/ - Contains the AuthService which manages registration, login, and JWT generation.
• Repositories/ - Contains the UserRepository which handles database interactions using Dapper.
• Validation/ - Contains the RegisterDtoValidator for validating user registration.

Troubleshooting

Common Issues

• JWT Key Size Error: Ensure that the JWT key in your appsettings.json is at least 32 characters long.
• Database Connection: Double-check your PostgreSQL connection string in appsettings.json and ensure the PostgreSQL service is running.
• Docker Issues: Ensure Docker is installed and running, and that the correct ports are exposed in the container.

License

This project is licensed under the MIT License. See the LICENSE file for details.