xareas / todoapi Goto Github PK

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
• JWT authentication
• Proxying requests from the front end application server using YARP's IHttpForwarder
• Rate Limiting
• Writing integration tests for your REST API

1. Install .NET 7

1. Install the dotnet-ef tool: dotnet tool install dotnet-ef -g
2. Navigate to the TodoApi folder and run dotnet ef database update to create the database.
3. Learn more about dotnet-ef

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

   {
     "username": "myuser",
     "password": "<put a password here>"
   }

2. To get a token for the above user run dotnet user-jwts to create a JWT token with the same user name specified above e.g:

   dotnet user-jwts create -n myuser
   

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

4. Learn more about user-jwts

TodoApi uses OpenTelemetry to collect logs, metrics and spans.

If you wish to view the collected telemetry, follow the steps below.

1. Run Prometheus with Docker:

docker run -d -p 9090:9090 --name prometheus -v $PWD/prometheus.yml:/etc/prometheus/prometheus.yml prom/prometheus

1. Open Prometheus in your browser
2. Query the collected metrics

1. Uncomment .AddOtlpExporter below builder.Services.AddOpenTelemetryTracing, in the TodoApi/OpenTelemetryExtensions.cs file
2. Run Jaeger with Docker:

docker run -d --name jaeger -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 -e COLLECTOR_OTLP_ENABLED=true -p 6831:6831/udp -p 6832:6832/udp -p 5778:5778 -p 16686:16686 -p 4317:4317 -p 4318:4318 -p 14250:14250 -p 14268:14268 -p 14269:14269 -p 9411:9411 jaegertracing/all-in-one:latest

1. Open Jaeger in your browser
2. View the collected spans

1. Uncomment .AddOtlpExporter below builder.Logging.AddOpenTelemetry, in the TodoApi/Extensions/OpenTelemetryExtensions.cs file
2. Find a Vendor that supports OpenTelemetry-based logging.

Vendor support for OpenTelemetry-based logging is currently very limited.