README.md

About project

Sample of Web API and tests with Database in Docker, along with "build as code" using Nuke Build.

Key features:

• ASP.NET Core 9.0
• Entity Framework Core 9.0 & PostgreSQL 17
• Build solution using Nuke build
• Dockerfile automatic generation support using Scriban
• API client generation using NSwag
• Integration tests with Docker using TestContainers and Respawn
• .NET Aspire standalone Dashboard
• Docker Compose to run all prerequisites (PostgreSQL, .NET Aspire Dashboard)
• Logging, Metrics, Tracing using OpenTelemetry

Prerequisites

Main

• .NET 9.0 SDK
• Docker

Running API

In order to run the API, you need to have a PostgreSQL database running. You can use the provided Docker Compose file to run it.

List of services:

• PostgreSQL: localhost:5432
• Aspire Dashboard: http://localhost:18888

Projects to start

API

Starts the HTTP-server

Tests

Execute all tests

dotnet test

Execute only integration tests

dotnet test --filter Category=IntegrationTests

Create Db Context migrations

#Install EF utils
dotnet tool install --global dotnet-ef

#Create schema migration
dotnet ef migrations add <Name of your migration> --startup-project src/Api -p src/Store -c PopulationDbContext

Build solution using Nuke build

Install the global tool

dotnet tool install Nuke.GlobalTool --global

Run build

Using a global tool

nuke

Using a PowerShell script

Execute from the root of the repository

pwsh build.ps1 -DockerRepositoriesUrl https://some.docker.registry -Branch some-dev-branch -BuildCounter 1 -DockerRepositoryName some-docker-repo-name -NuGetUrl https://some.nuget.registry -NuGetFeedName some-nuget-feed-name -NuGetApiKey some-nuget-api-key

Execution plan

Execute the following command to see the interactive execution plan

nuke --plan

API Client

API client is generated using NSwag tool.

It generates automatically when ClientGenerator project is built.

See more details in NSwag documentation and nswag.json file.