README.md

Todo application with ASP.NET Core

This is a Todo application that features:

• Todo.Web - An ASP.NET Core hosted Blazor WASM front end application
• TodoApi - An ASP.NET Core REST API backend using minimal APIs

It showcases:

• Blazor WebAssembly
• Minimal APIs
• Using EntityFramework and SQLite for data access
• OpenAPI
• User management with ASP.NET Core Identity
• Cookie authentication
• Bearer authentication
• Proxying requests from the front end application server using YARP's IHttpForwarder
• Rate Limiting
• Writing integration tests for your REST API

Prerequisites

.NET

1. Install .NET 8

Database

1. Install the dotnet-ef tool: dotnet tool install dotnet-ef -g
2. Learn more about dotnet-ef

Running the application

To run the application, run the TodoApi.AppHost project. This uses .NET Aspire to run both the Todo.Web/Server and TodoApi.

Optional

Using the API standalone

The Todo REST API can run standalone as well. You can run the TodoApi project and make requests to various endpoints using the Swagger UI (or a client of your choice):

Before executing any requests, you need to create a user and get an auth token.

1. To create a new user, run the application and POST a JSON payload to /users/register endpoint:

   {
     "email": "[email protected]",
     "password": "<put a password here>"
   }

2. To get a token for the above user, hit the /users/login endpoint with the above user email and password. The response will look like this:

   {
     "tokenType": "Bearer",
     "accessToken": "string",
     "expiresIn": <seconds>,
     "refreshToken": "string"
   }

3. You should be able to use the accessToken to make authenticated requests to the todo endpoints.

Social authentication

In addition to username and password, social authentication providers can be configured to work with this todo application. By default it supports Github, Google, and Microsoft accounts.

Instructions for setting up each of these providers can be found at:

• Github
• Microsoft
• Google

Once you obtain the client id and client secret, the configuration for these providers must be added with the following schema:

{
    "Authentication": {
        "Schemes": {
            "<scheme>": {
                "ClientId": "xxx",
                "ClientSecret": "xxxx"
            }
        }
    }
}

Or using environment variables:

Authentication__Schemes__<scheme>__ClientId=xxx
Authentication__Schemes__<scheme>__ClientSecret=xxx

Or using user secrets:

dotnet user-secrets set Authentication:Schemes:<scheme>:ClientId xxx
dotnet user-secrets set Authentication:Schemes:<scheme>:ClientSecret xxx

Other providers can be found here. These must be added to AuthenticationExtensions as well.

NOTE: Don't store client secrets in configuration!

Auth0

This sample has Auth0 configured as an OIDC server. It can be configured with the following schema:

{
  "Authentication": {
    "Schemes": {
      "Auth0": {
        "Audience": "<audience>",
        "Domain": "<domain>",
        "ClientId": "<client id>",
        "ClientSecret": "<client secret>"
      }
    }
  }
}

Learn more about the Auth0 .NET SDK here.

OpenTelemetry

TodoApi uses OpenTelemetry to collect logs, metrics and spans. You can see this using the Aspire Dashboard.