diff --git a/src/CleanApiStarter.Api/Endpoints/GoogleLoginPage.cs b/src/CleanApiStarter.Api/Endpoints/GoogleLoginPage.cs
new file mode 100644
index 0000000..e57f2ec
--- /dev/null
+++ b/src/CleanApiStarter.Api/Endpoints/GoogleLoginPage.cs
@@ -0,0 +1,65 @@
+namespace CleanApiStarter.Api.Endpoints;
+
+public static class GoogleLoginPage
+{
+ public static WebApplication MapGoogleLoginPage(this WebApplication app)
+ {
+ if (!app.Environment.IsDevelopment())
+ {
+ return app;
+ }
+
+ app.MapGet("/auth/google-login", (AppSettings appSettings) =>
+ {
+ string clientId = HtmlEncoder.Default.Encode(appSettings.Authentication.Google.ClientId);
+
+ string html =
+ $$"""
+
+
+
+
+
+ Google Login
+
+
+
+
+ Google Login
+
+
+
+ API JWT
+ Sign in with Google to generate a token.
+
+
+
+
+ """;
+
+ return Results.Content(html, "text/html");
+ })
+ .AllowAnonymous()
+ .WithName("GoogleLoginPage");
+
+ return app;
+ }
+}
diff --git a/src/CleanApiStarter.Api/Endpoints/V1/Auth.cs b/src/CleanApiStarter.Api/Endpoints/V1/Auth.cs
new file mode 100644
index 0000000..13fa398
--- /dev/null
+++ b/src/CleanApiStarter.Api/Endpoints/V1/Auth.cs
@@ -0,0 +1,39 @@
+namespace CleanApiStarter.Api.Endpoints.V1;
+
+public sealed class Auth : IEndpointGroup
+{
+ public static int MajorVersion => 1;
+
+ public static string RoutePrefix => "/api/auth";
+
+ public static void Map(RouteGroupBuilder groupBuilder)
+ {
+ groupBuilder.MapPost("/google", SignInWithGoogle)
+ .AllowAnonymous()
+ .WithName("SignInWithGoogleV1");
+
+ groupBuilder.MapGet("/me", GetCurrentUser)
+ .RequireAuthorization()
+ .WithName("GetCurrentUserV1");
+ }
+
+ private static async Task SignInWithGoogle(
+ GoogleSignInDto signInDto,
+ IAuthService authService,
+ CancellationToken cancellationToken)
+ {
+ AuthTokenDto token = await authService.SignInWithGoogleAsync(signInDto, cancellationToken);
+
+ return Results.Ok(token);
+ }
+
+ private static async Task GetCurrentUser(
+ ClaimsPrincipal principal,
+ IAuthService authService,
+ CancellationToken cancellationToken)
+ {
+ CurrentUserDto currentUser = await authService.GetCurrentUserAsync(principal, cancellationToken);
+
+ return Results.Ok(currentUser);
+ }
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Api/Endpoints/V1/Words.cs b/src/CleanApiStarter.Api/Endpoints/V1/Words.cs
index 9aeb17c..0b8c011 100644
--- a/src/CleanApiStarter.Api/Endpoints/V1/Words.cs
+++ b/src/CleanApiStarter.Api/Endpoints/V1/Words.cs
@@ -8,6 +8,8 @@ public sealed class Words : IEndpointGroup
public static void Map(RouteGroupBuilder groupBuilder)
{
+ groupBuilder.RequireAuthorization();
+
groupBuilder.MapPost("/", CreateWord)
.WithName("CreateWordV1");
@@ -73,4 +75,4 @@ private static async Task DeleteWord(
return success ? Results.NoContent() : Results.NotFound();
}
-}
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Api/Endpoints/V2/Words.cs b/src/CleanApiStarter.Api/Endpoints/V2/Words.cs
index c869ab6..27bd502 100644
--- a/src/CleanApiStarter.Api/Endpoints/V2/Words.cs
+++ b/src/CleanApiStarter.Api/Endpoints/V2/Words.cs
@@ -8,6 +8,8 @@ public sealed class Words : IEndpointGroup
public static void Map(RouteGroupBuilder groupBuilder)
{
+ groupBuilder.RequireAuthorization();
+
groupBuilder.MapGet("/", GetAllWords)
.WithName("GetAllWordsV2");
}
@@ -24,4 +26,4 @@ private static async Task GetAllWords(
Items = words
});
}
-}
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Api/GlobalUsings.cs b/src/CleanApiStarter.Api/GlobalUsings.cs
index 01ef137..43234fb 100644
--- a/src/CleanApiStarter.Api/GlobalUsings.cs
+++ b/src/CleanApiStarter.Api/GlobalUsings.cs
@@ -1,10 +1,15 @@
// Global using directives
global using System.Reflection;
+global using System.Security.Claims;
+global using System.Text.Encodings.Web;
+global using CleanApiStarter.Api.Endpoints;
+global using CleanApiStarter.Api.Services;
global using CleanApiStarter.Application;
-global using CleanApiStarter.Application.Interfaces;
-global using CleanApiStarter.Application.Models;
+global using CleanApiStarter.Application.Common.Interfaces;
+global using CleanApiStarter.Application.Features.Auth;
+global using CleanApiStarter.Application.Features.Words;
global using CleanApiStarter.AspNetCore;
global using CleanApiStarter.Configuration;
global using CleanApiStarter.Infrastructure;
@@ -12,4 +17,4 @@
global using Microsoft.AspNetCore.Http;
global using Microsoft.AspNetCore.Routing;
-global using Scalar.AspNetCore;
+global using Scalar.AspNetCore;
\ No newline at end of file
diff --git a/src/CleanApiStarter.Api/Program.cs b/src/CleanApiStarter.Api/Program.cs
index 05392a3..d599159 100644
--- a/src/CleanApiStarter.Api/Program.cs
+++ b/src/CleanApiStarter.Api/Program.cs
@@ -2,12 +2,13 @@
builder.AddAspNetCoreDefaults();
-builder.Services.AddEndpointsApiExplorer();
-builder.Services.AddOpenApi();
-
-builder.Services.AddAppSettings(builder.Configuration);
-builder.Services.AddApplication();
-builder.Services.AddInfrastructure();
+builder.Services.AddEndpointsApiExplorer();
+builder.Services.AddOpenApi();
+
+builder.Services.AddAppSettings(builder.Configuration);
+builder.Services.AddApplication();
+builder.Services.AddInfrastructure();
+builder.Services.AddScoped();
WebApplication app = builder.Build();
@@ -20,7 +21,8 @@
app.UseAspNetCoreDefaults();
app.UseHttpsRedirection();
+app.MapGoogleLoginPage();
app.MapEndpoints(Assembly.GetExecutingAssembly());
app.MapDefaultEndpoints();
-app.Run();
+app.Run();
\ No newline at end of file
diff --git a/src/CleanApiStarter.Api/Services/CurrentUser.cs b/src/CleanApiStarter.Api/Services/CurrentUser.cs
new file mode 100644
index 0000000..c48f384
--- /dev/null
+++ b/src/CleanApiStarter.Api/Services/CurrentUser.cs
@@ -0,0 +1,9 @@
+namespace CleanApiStarter.Api.Services;
+
+public class CurrentUser(IHttpContextAccessor httpContextAccessor) : IUser
+{
+ public string? Id => httpContextAccessor.HttpContext?.User.FindFirstValue(ClaimTypes.NameIdentifier);
+
+ public List? Roles =>
+ httpContextAccessor.HttpContext?.User.FindAll(ClaimTypes.Role).Select(x => x.Value).ToList();
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Api/appsettings.Development.json b/src/CleanApiStarter.Api/appsettings.Development.json
index 1690903..68309f2 100644
--- a/src/CleanApiStarter.Api/appsettings.Development.json
+++ b/src/CleanApiStarter.Api/appsettings.Development.json
@@ -1,5 +1,16 @@
{
"ConnectionStrings": {
"Postgres": "Host=localhost;Port=5432;Database=postgres;Username=postgres;Password=postgres"
+ },
+ "Authentication": {
+ "Google": {
+ "ClientId": ""
+ },
+ "Jwt": {
+ "Issuer": "CleanApiStarter",
+ "Audience": "CleanApiStarter.Api",
+ "SigningKey": "development-only-signing-key-change-me",
+ "ExpirationMinutes": 60
+ }
}
}
diff --git a/src/CleanApiStarter.Application/Common/Interfaces/IUser.cs b/src/CleanApiStarter.Application/Common/Interfaces/IUser.cs
new file mode 100644
index 0000000..00c53cc
--- /dev/null
+++ b/src/CleanApiStarter.Application/Common/Interfaces/IUser.cs
@@ -0,0 +1,7 @@
+namespace CleanApiStarter.Application.Common.Interfaces;
+
+public interface IUser
+{
+ string? Id { get; }
+ List? Roles { get; }
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Application/Features/Auth/AuthTokenDto.cs b/src/CleanApiStarter.Application/Features/Auth/AuthTokenDto.cs
new file mode 100644
index 0000000..7f32c89
--- /dev/null
+++ b/src/CleanApiStarter.Application/Features/Auth/AuthTokenDto.cs
@@ -0,0 +1,8 @@
+namespace CleanApiStarter.Application.Features.Auth;
+
+public sealed class AuthTokenDto
+{
+ public string AccessToken { get; init; } = string.Empty;
+
+ public DateTimeOffset ExpiresAt { get; init; }
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Application/Features/Auth/CurrentUserDto.cs b/src/CleanApiStarter.Application/Features/Auth/CurrentUserDto.cs
new file mode 100644
index 0000000..f2618c7
--- /dev/null
+++ b/src/CleanApiStarter.Application/Features/Auth/CurrentUserDto.cs
@@ -0,0 +1,12 @@
+namespace CleanApiStarter.Application.Features.Auth;
+
+public sealed class CurrentUserDto
+{
+ public string UserId { get; init; } = string.Empty;
+
+ public string Email { get; init; } = string.Empty;
+
+ public string Name { get; init; } = string.Empty;
+
+ public IReadOnlyCollection Roles { get; init; } = [];
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Application/Features/Auth/GoogleSignInDto.cs b/src/CleanApiStarter.Application/Features/Auth/GoogleSignInDto.cs
new file mode 100644
index 0000000..3eb4663
--- /dev/null
+++ b/src/CleanApiStarter.Application/Features/Auth/GoogleSignInDto.cs
@@ -0,0 +1,6 @@
+namespace CleanApiStarter.Application.Features.Auth;
+
+public sealed class GoogleSignInDto
+{
+ public string IdToken { get; init; } = string.Empty;
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Application/Features/Auth/IAuthService.cs b/src/CleanApiStarter.Application/Features/Auth/IAuthService.cs
new file mode 100644
index 0000000..27bcb46
--- /dev/null
+++ b/src/CleanApiStarter.Application/Features/Auth/IAuthService.cs
@@ -0,0 +1,8 @@
+namespace CleanApiStarter.Application.Features.Auth;
+
+public interface IAuthService
+{
+ Task SignInWithGoogleAsync(GoogleSignInDto signInDto, CancellationToken cancellationToken);
+
+ Task GetCurrentUserAsync(ClaimsPrincipal principal, CancellationToken cancellationToken);
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Application/Interfaces/IWordRepository.cs b/src/CleanApiStarter.Application/Features/Words/IWordRepository.cs
similarity index 88%
rename from src/CleanApiStarter.Application/Interfaces/IWordRepository.cs
rename to src/CleanApiStarter.Application/Features/Words/IWordRepository.cs
index c38a9c3..75aac8c 100644
--- a/src/CleanApiStarter.Application/Interfaces/IWordRepository.cs
+++ b/src/CleanApiStarter.Application/Features/Words/IWordRepository.cs
@@ -1,10 +1,10 @@
-namespace CleanApiStarter.Application.Interfaces;
-
-public interface IWordRepository
-{
- Task AddWordAsync(Word word, CancellationToken cancellationToken);
- Task GetWordByIdAsync(Guid id, CancellationToken cancellationToken);
- Task> GetAllWordsAsync(CancellationToken cancellationToken);
- Task UpdateWordAsync(Word word, CancellationToken cancellationToken);
- Task DeleteWordAsync(Guid id, CancellationToken cancellationToken);
+namespace CleanApiStarter.Application.Features.Words;
+
+public interface IWordRepository
+{
+ Task AddWordAsync(Word word, CancellationToken cancellationToken);
+ Task GetWordByIdAsync(Guid id, CancellationToken cancellationToken);
+ Task> GetAllWordsAsync(CancellationToken cancellationToken);
+ Task UpdateWordAsync(Word word, CancellationToken cancellationToken);
+ Task DeleteWordAsync(Guid id, CancellationToken cancellationToken);
}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Application/Interfaces/IWordService.cs b/src/CleanApiStarter.Application/Features/Words/IWordService.cs
similarity index 88%
rename from src/CleanApiStarter.Application/Interfaces/IWordService.cs
rename to src/CleanApiStarter.Application/Features/Words/IWordService.cs
index 4ff4a63..8797d87 100644
--- a/src/CleanApiStarter.Application/Interfaces/IWordService.cs
+++ b/src/CleanApiStarter.Application/Features/Words/IWordService.cs
@@ -1,10 +1,10 @@
-namespace CleanApiStarter.Application.Interfaces;
-
-public interface IWordService
-{
- Task AddWordAsync(CreateWordDto wordDto, CancellationToken cancellationToken);
- Task GetWordByIdAsync(Guid id, CancellationToken cancellationToken);
- Task> GetAllWordsAsync(CancellationToken cancellationToken);
- Task UpdateWordAsync(Guid id, CreateWordDto wordDto, CancellationToken cancellationToken);
- Task DeleteWordAsync(Guid id, CancellationToken cancellationToken);
+namespace CleanApiStarter.Application.Features.Words;
+
+public interface IWordService
+{
+ Task AddWordAsync(CreateWordDto wordDto, CancellationToken cancellationToken);
+ Task GetWordByIdAsync(Guid id, CancellationToken cancellationToken);
+ Task> GetAllWordsAsync(CancellationToken cancellationToken);
+ Task UpdateWordAsync(Guid id, CreateWordDto wordDto, CancellationToken cancellationToken);
+ Task DeleteWordAsync(Guid id, CancellationToken cancellationToken);
}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Application/Models/WordDto.cs b/src/CleanApiStarter.Application/Features/Words/WordDto.cs
similarity index 89%
rename from src/CleanApiStarter.Application/Models/WordDto.cs
rename to src/CleanApiStarter.Application/Features/Words/WordDto.cs
index 645bf2c..ef18d55 100644
--- a/src/CleanApiStarter.Application/Models/WordDto.cs
+++ b/src/CleanApiStarter.Application/Features/Words/WordDto.cs
@@ -1,18 +1,18 @@
-namespace CleanApiStarter.Application.Models;
-
-public class WordDto
-{
- public Guid Id { get; set; }
- public string Text { get; set; } = string.Empty;
- public string Meaning { get; set; } = string.Empty;
- public List Synonyms { get; set; } = new();
- public string UsageExample { get; set; } = string.Empty;
-}
-
-public class CreateWordDto
-{
- public string Text { get; set; } = string.Empty;
- public string Meaning { get; set; } = string.Empty;
- public List Synonyms { get; set; } = new();
- public string UsageExample { get; set; } = string.Empty;
+namespace CleanApiStarter.Application.Features.Words;
+
+public class WordDto
+{
+ public Guid Id { get; set; }
+ public string Text { get; set; } = string.Empty;
+ public string Meaning { get; set; } = string.Empty;
+ public List Synonyms { get; set; } = new();
+ public string UsageExample { get; set; } = string.Empty;
+}
+
+public class CreateWordDto
+{
+ public string Text { get; set; } = string.Empty;
+ public string Meaning { get; set; } = string.Empty;
+ public List Synonyms { get; set; } = new();
+ public string UsageExample { get; set; } = string.Empty;
}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Application/Services/WordService.cs b/src/CleanApiStarter.Application/Features/Words/WordService.cs
similarity index 95%
rename from src/CleanApiStarter.Application/Services/WordService.cs
rename to src/CleanApiStarter.Application/Features/Words/WordService.cs
index 9f1b7fb..ceb05cd 100644
--- a/src/CleanApiStarter.Application/Services/WordService.cs
+++ b/src/CleanApiStarter.Application/Features/Words/WordService.cs
@@ -1,105 +1,105 @@
-namespace CleanApiStarter.Application.Services;
-
-public class WordService(IWordRepository wordRepository, ILogger logger) : IWordService
-{
- public async Task AddWordAsync(CreateWordDto wordDto, CancellationToken cancellationToken)
- {
- Word word = new()
- {
- Id = Guid.NewGuid(),
- Text = wordDto.Text,
- Meaning = wordDto.Meaning,
- Synonyms = wordDto.Synonyms,
- UsageExample = wordDto.UsageExample,
- CreatedAt = DateTime.UtcNow
- };
-
- logger.LogInformation(
- "Creating word {WordId} with {SynonymCount} synonyms",
- word.Id,
- word.Synonyms.Count);
-
- Guid wordId = await wordRepository.AddWordAsync(word, cancellationToken);
-
- logger.LogInformation("Created word {WordId}", wordId);
-
- return wordId;
- }
-
- public async Task GetWordByIdAsync(Guid id, CancellationToken cancellationToken)
- {
- Word? word = await wordRepository.GetWordByIdAsync(id, cancellationToken);
-
- if (word == null)
- {
- logger.LogWarning("Word {WordId} was not found", id);
- return null;
- }
-
- logger.LogInformation("Retrieved word {WordId}", id);
-
- return MapToDto(word);
- }
-
- public async Task> GetAllWordsAsync(CancellationToken cancellationToken)
- {
- IEnumerable words = await wordRepository.GetAllWordsAsync(cancellationToken);
- Word[] wordList = words.ToArray();
-
- logger.LogInformation("Retrieved {WordCount} words", wordList.Length);
-
- return wordList.Select(MapToDto);
- }
-
- public async Task UpdateWordAsync(Guid id, CreateWordDto wordDto, CancellationToken cancellationToken)
- {
- Word? existingWord = await wordRepository.GetWordByIdAsync(id, cancellationToken);
- if (existingWord == null)
- {
- logger.LogWarning("Word {WordId} could not be updated because it was not found", id);
- return false;
- }
-
- existingWord.Text = wordDto.Text;
- existingWord.Meaning = wordDto.Meaning;
- existingWord.Synonyms = wordDto.Synonyms;
- existingWord.UsageExample = wordDto.UsageExample;
- existingWord.UpdatedAt = DateTime.UtcNow;
-
- bool updated = await wordRepository.UpdateWordAsync(existingWord, cancellationToken);
-
- logger.LogInformation(
- "Updated word {WordId}; success: {UpdateSucceeded}",
- id,
- updated);
-
- return updated;
- }
-
- public async Task DeleteWordAsync(Guid id, CancellationToken cancellationToken)
- {
- bool deleted = await wordRepository.DeleteWordAsync(id, cancellationToken);
-
- if (!deleted)
- {
- logger.LogWarning("Word {WordId} could not be deleted because it was not found", id);
- return false;
- }
-
- logger.LogInformation("Deleted word {WordId}", id);
-
- return true;
- }
-
- private static WordDto MapToDto(Word word)
- {
- return new WordDto
- {
- Id = word.Id,
- Text = word.Text,
- Meaning = word.Meaning,
- Synonyms = word.Synonyms,
- UsageExample = word.UsageExample
- };
- }
+namespace CleanApiStarter.Application.Features.Words;
+
+public class WordService(IWordRepository wordRepository, ILogger logger) : IWordService
+{
+ public async Task AddWordAsync(CreateWordDto wordDto, CancellationToken cancellationToken)
+ {
+ Word word = new()
+ {
+ Id = Guid.NewGuid(),
+ Text = wordDto.Text,
+ Meaning = wordDto.Meaning,
+ Synonyms = wordDto.Synonyms,
+ UsageExample = wordDto.UsageExample,
+ CreatedAt = DateTime.UtcNow
+ };
+
+ logger.LogInformation(
+ "Creating word {WordId} with {SynonymCount} synonyms",
+ word.Id,
+ word.Synonyms.Count);
+
+ Guid wordId = await wordRepository.AddWordAsync(word, cancellationToken);
+
+ logger.LogInformation("Created word {WordId}", wordId);
+
+ return wordId;
+ }
+
+ public async Task GetWordByIdAsync(Guid id, CancellationToken cancellationToken)
+ {
+ Word? word = await wordRepository.GetWordByIdAsync(id, cancellationToken);
+
+ if (word == null)
+ {
+ logger.LogWarning("Word {WordId} was not found", id);
+ return null;
+ }
+
+ logger.LogInformation("Retrieved word {WordId}", id);
+
+ return MapToDto(word);
+ }
+
+ public async Task> GetAllWordsAsync(CancellationToken cancellationToken)
+ {
+ IEnumerable words = await wordRepository.GetAllWordsAsync(cancellationToken);
+ Word[] wordList = words.ToArray();
+
+ logger.LogInformation("Retrieved {WordCount} words", wordList.Length);
+
+ return wordList.Select(MapToDto);
+ }
+
+ public async Task UpdateWordAsync(Guid id, CreateWordDto wordDto, CancellationToken cancellationToken)
+ {
+ Word? existingWord = await wordRepository.GetWordByIdAsync(id, cancellationToken);
+ if (existingWord == null)
+ {
+ logger.LogWarning("Word {WordId} could not be updated because it was not found", id);
+ return false;
+ }
+
+ existingWord.Text = wordDto.Text;
+ existingWord.Meaning = wordDto.Meaning;
+ existingWord.Synonyms = wordDto.Synonyms;
+ existingWord.UsageExample = wordDto.UsageExample;
+ existingWord.UpdatedAt = DateTime.UtcNow;
+
+ bool updated = await wordRepository.UpdateWordAsync(existingWord, cancellationToken);
+
+ logger.LogInformation(
+ "Updated word {WordId}; success: {UpdateSucceeded}",
+ id,
+ updated);
+
+ return updated;
+ }
+
+ public async Task DeleteWordAsync(Guid id, CancellationToken cancellationToken)
+ {
+ bool deleted = await wordRepository.DeleteWordAsync(id, cancellationToken);
+
+ if (!deleted)
+ {
+ logger.LogWarning("Word {WordId} could not be deleted because it was not found", id);
+ return false;
+ }
+
+ logger.LogInformation("Deleted word {WordId}", id);
+
+ return true;
+ }
+
+ private static WordDto MapToDto(Word word)
+ {
+ return new WordDto
+ {
+ Id = word.Id,
+ Text = word.Text,
+ Meaning = word.Meaning,
+ Synonyms = word.Synonyms,
+ UsageExample = word.UsageExample
+ };
+ }
}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Application/GlobalUsings.cs b/src/CleanApiStarter.Application/GlobalUsings.cs
index 2e2a517..b92085b 100644
--- a/src/CleanApiStarter.Application/GlobalUsings.cs
+++ b/src/CleanApiStarter.Application/GlobalUsings.cs
@@ -1,6 +1,6 @@
-global using CleanApiStarter.Application.Interfaces;
-global using CleanApiStarter.Application.Models;
-global using CleanApiStarter.Application.Services;
+global using System.Security.Claims;
+
+global using CleanApiStarter.Application.Features.Words;
global using CleanApiStarter.Domain.Entities;
global using Microsoft.Extensions.DependencyInjection;
diff --git a/src/CleanApiStarter.AspNetCore/AspNetCoreDefaultServices.cs b/src/CleanApiStarter.AspNetCore/AspNetCoreDefaultServices.cs
index 645a49b..101b619 100644
--- a/src/CleanApiStarter.AspNetCore/AspNetCoreDefaultServices.cs
+++ b/src/CleanApiStarter.AspNetCore/AspNetCoreDefaultServices.cs
@@ -6,6 +6,8 @@ private static void AddSecurityDefaults(this IHostApplicationBuilder builder)
{
builder.Services.Configure(
options => options.AddServerHeader = false);
+
+ builder.Services.AddHttpContextAccessor();
}
private static void AddProblemDetailsDefaults(this IHostApplicationBuilder builder)
@@ -19,24 +21,53 @@ private static void AddApiVersioningDefaults(this IHostApplicationBuilder builde
builder.Services.AddApiVersioning(options =>
{
options.DefaultApiVersion = new ApiVersion(1);
- options.AssumeDefaultVersionWhenUnspecified = false;
+ options.AssumeDefaultVersionWhenUnspecified = true;
options.ReportApiVersions = true;
options.ApiVersionReader = new HeaderApiVersionReader("X-Api-Version");
});
}
+ private static void AddAuthenticationDefaults(this WebApplicationBuilder builder)
+ {
+ builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
+ .AddJwtBearer();
+
+ builder.Services.AddAuthorization();
+
+ builder.Services.AddOptions(JwtBearerDefaults.AuthenticationScheme)
+ .Configure((options, appSettings) =>
+ {
+ JwtAuthenticationSettings jwtSettings = appSettings.Authentication.Jwt;
+
+ options.TokenValidationParameters = new TokenValidationParameters
+ {
+ ValidateIssuer = true,
+ ValidIssuer = jwtSettings.Issuer,
+ ValidateAudience = true,
+ ValidAudience = jwtSettings.Audience,
+ ValidateIssuerSigningKey = true,
+ IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(jwtSettings.SigningKey)),
+ ValidateLifetime = true,
+ ClockSkew = TimeSpan.FromMinutes(1)
+ };
+ });
+ }
+
private static void AddHttpLoggingDefaults(this IHostApplicationBuilder builder)
{
builder.Logging.AddFilter("Microsoft.AspNetCore.HttpLogging", LogLevel.Information);
builder.Services.AddHttpLogging(options =>
{
+ options.CombineLogs = true;
options.LoggingFields =
HttpLoggingFields.RequestMethod |
HttpLoggingFields.RequestPath |
HttpLoggingFields.ResponseStatusCode |
HttpLoggingFields.Duration;
});
+
+ builder.Services.AddHttpLoggingInterceptor();
}
private static void AddServiceDiscoveryDefaults(this IHostApplicationBuilder builder)
diff --git a/src/CleanApiStarter.AspNetCore/CleanApiStarter.AspNetCore.csproj b/src/CleanApiStarter.AspNetCore/CleanApiStarter.AspNetCore.csproj
index 9247916..cf25978 100644
--- a/src/CleanApiStarter.AspNetCore/CleanApiStarter.AspNetCore.csproj
+++ b/src/CleanApiStarter.AspNetCore/CleanApiStarter.AspNetCore.csproj
@@ -5,9 +5,14 @@
CleanApiStarter.AspNetCore
+
+
+
+
+
diff --git a/src/CleanApiStarter.AspNetCore/Extensions.cs b/src/CleanApiStarter.AspNetCore/Extensions.cs
index 38f29f1..dd2b540 100644
--- a/src/CleanApiStarter.AspNetCore/Extensions.cs
+++ b/src/CleanApiStarter.AspNetCore/Extensions.cs
@@ -14,6 +14,7 @@ public static WebApplicationBuilder AddAspNetCoreDefaults(this WebApplicationBui
builder.AddSecurityDefaults();
builder.AddProblemDetailsDefaults();
builder.AddApiVersioningDefaults();
+ builder.AddAuthenticationDefaults();
builder.AddHttpLoggingDefaults();
builder.AddServiceDiscoveryDefaults();
builder.Services.AddHealthChecks()
@@ -25,7 +26,9 @@ public static WebApplicationBuilder AddAspNetCoreDefaults(this WebApplicationBui
public static WebApplication UseAspNetCoreDefaults(this WebApplication app)
{
app.UseExceptionHandler();
+ app.UseAuthentication();
app.UseHttpLogging();
+ app.UseAuthorization();
return app;
}
@@ -59,4 +62,4 @@ public static WebApplication MapDefaultEndpoints(this WebApplication app)
return app;
}
-}
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.AspNetCore/GlobalUsings.cs b/src/CleanApiStarter.AspNetCore/GlobalUsings.cs
index b863a3a..d12fd40 100644
--- a/src/CleanApiStarter.AspNetCore/GlobalUsings.cs
+++ b/src/CleanApiStarter.AspNetCore/GlobalUsings.cs
@@ -1,23 +1,29 @@
-global using System.Reflection;
-
-global using Asp.Versioning;
-global using Asp.Versioning.Builder;
-
-global using Microsoft.AspNetCore.Builder;
-global using Microsoft.AspNetCore.Diagnostics;
-global using Microsoft.AspNetCore.Diagnostics.HealthChecks;
-global using Microsoft.AspNetCore.Http;
-global using Microsoft.AspNetCore.HttpLogging;
-global using Microsoft.AspNetCore.Mvc;
-global using Microsoft.AspNetCore.Routing;
-global using Microsoft.Extensions.DependencyInjection;
-global using Microsoft.Extensions.Diagnostics.HealthChecks;
-global using Microsoft.Extensions.Hosting;
-global using Microsoft.Extensions.Logging;
+global using System.IdentityModel.Tokens.Jwt;
+global using System.Reflection;
+global using System.Security.Claims;
+global using System.Text;
+
+global using Asp.Versioning;
+global using Asp.Versioning.Builder;
+
+global using CleanApiStarter.Configuration;
+
+global using Microsoft.AspNetCore.Authentication.JwtBearer;
+global using Microsoft.AspNetCore.Builder;
+global using Microsoft.AspNetCore.Diagnostics;
+global using Microsoft.AspNetCore.Diagnostics.HealthChecks;
+global using Microsoft.AspNetCore.Http;
+global using Microsoft.AspNetCore.HttpLogging;
+global using Microsoft.AspNetCore.Mvc;
+global using Microsoft.AspNetCore.Routing;
+global using Microsoft.Extensions.DependencyInjection;
+global using Microsoft.Extensions.Diagnostics.HealthChecks;
+global using Microsoft.Extensions.Hosting;
+global using Microsoft.Extensions.Logging;
+global using Microsoft.IdentityModel.Tokens;
global using Npgsql;
-global using OpenTelemetry;
global using OpenTelemetry.Logs;
global using OpenTelemetry.Metrics;
-global using OpenTelemetry.Trace;
+global using OpenTelemetry.Trace;
\ No newline at end of file
diff --git a/src/CleanApiStarter.AspNetCore/IEndpointGroup.cs b/src/CleanApiStarter.AspNetCore/IEndpointGroup.cs
index 66a2135..cc4f2e9 100644
--- a/src/CleanApiStarter.AspNetCore/IEndpointGroup.cs
+++ b/src/CleanApiStarter.AspNetCore/IEndpointGroup.cs
@@ -7,4 +7,4 @@ public interface IEndpointGroup
static virtual string? RoutePrefix => null;
static abstract void Map(RouteGroupBuilder groupBuilder);
-}
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.AspNetCore/OpenTelemetryDefaults.cs b/src/CleanApiStarter.AspNetCore/OpenTelemetryDefaults.cs
index 70733a2..154ef68 100644
--- a/src/CleanApiStarter.AspNetCore/OpenTelemetryDefaults.cs
+++ b/src/CleanApiStarter.AspNetCore/OpenTelemetryDefaults.cs
@@ -38,4 +38,4 @@ private static IHostApplicationBuilder ConfigureOpenTelemetry(this IHostApplicat
return builder;
}
-}
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.AspNetCore/ProblemDetailsExceptionHandler.cs b/src/CleanApiStarter.AspNetCore/ProblemDetailsExceptionHandler.cs
index 0c2320c..4f270a9 100644
--- a/src/CleanApiStarter.AspNetCore/ProblemDetailsExceptionHandler.cs
+++ b/src/CleanApiStarter.AspNetCore/ProblemDetailsExceptionHandler.cs
@@ -1,6 +1,6 @@
namespace CleanApiStarter.AspNetCore;
-public sealed class ProblemDetailsExceptionHandler : IExceptionHandler
+public sealed class ProblemDetailsExceptionHandler(ILogger logger) : IExceptionHandler
{
public async ValueTask TryHandleAsync(
HttpContext httpContext,
@@ -46,6 +46,24 @@ public async ValueTask TryHandleAsync(
})
};
+ if (statusCode >= StatusCodes.Status500InternalServerError)
+ {
+ logger.LogError(
+ exception,
+ "Unhandled exception while processing {RequestMethod} {RequestPath}",
+ httpContext.Request.Method,
+ httpContext.Request.Path);
+ }
+ else
+ {
+ logger.LogWarning(
+ exception,
+ "Handled exception with status {StatusCode} while processing {RequestMethod} {RequestPath}",
+ statusCode,
+ httpContext.Request.Method,
+ httpContext.Request.Path);
+ }
+
httpContext.Response.StatusCode = statusCode;
await httpContext.Response.WriteAsJsonAsync(problemDetails, cancellationToken);
diff --git a/src/CleanApiStarter.AspNetCore/UserIdHttpLoggingInterceptor.cs b/src/CleanApiStarter.AspNetCore/UserIdHttpLoggingInterceptor.cs
new file mode 100644
index 0000000..4e8fff7
--- /dev/null
+++ b/src/CleanApiStarter.AspNetCore/UserIdHttpLoggingInterceptor.cs
@@ -0,0 +1,28 @@
+namespace CleanApiStarter.AspNetCore;
+
+public sealed class UserIdHttpLoggingInterceptor : IHttpLoggingInterceptor
+{
+ private const string UserIdParameterName = "UserId";
+ private const string AnonymousUserId = "anonymous";
+
+ public ValueTask OnRequestAsync(HttpLoggingInterceptorContext logContext)
+ {
+ logContext.AddParameter(UserIdParameterName, GetUserId(logContext.HttpContext));
+
+ return ValueTask.CompletedTask;
+ }
+
+ public ValueTask OnResponseAsync(HttpLoggingInterceptorContext logContext)
+ {
+ logContext.AddParameter(UserIdParameterName, GetUserId(logContext.HttpContext));
+
+ return ValueTask.CompletedTask;
+ }
+
+ private static string GetUserId(HttpContext httpContext)
+ {
+ return httpContext.User.FindFirstValue(ClaimTypes.NameIdentifier)
+ ?? httpContext.User.FindFirstValue(JwtRegisteredClaimNames.Sub)
+ ?? AnonymousUserId;
+ }
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.AspNetCore/WebApplicationExtensions.cs b/src/CleanApiStarter.AspNetCore/WebApplicationExtensions.cs
index 59f4337..023c50b 100644
--- a/src/CleanApiStarter.AspNetCore/WebApplicationExtensions.cs
+++ b/src/CleanApiStarter.AspNetCore/WebApplicationExtensions.cs
@@ -36,4 +36,4 @@ private static ApiVersion GetApiVersion(Type endpointGroupType)
return new ApiVersion(majorVersion);
}
-}
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Configuration/AppSettings.cs b/src/CleanApiStarter.Configuration/AppSettings.cs
index fd74519..a0f32ea 100644
--- a/src/CleanApiStarter.Configuration/AppSettings.cs
+++ b/src/CleanApiStarter.Configuration/AppSettings.cs
@@ -5,4 +5,8 @@ public sealed class AppSettings
[Required]
[ValidateObjectMembers]
public ConnectionStringSettings ConnectionStrings { get; set; } = new();
-}
+
+ [Required]
+ [ValidateObjectMembers]
+ public AuthenticationSettings Authentication { get; set; } = new();
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Configuration/AuthenticationSettings.cs b/src/CleanApiStarter.Configuration/AuthenticationSettings.cs
new file mode 100644
index 0000000..ff38cd4
--- /dev/null
+++ b/src/CleanApiStarter.Configuration/AuthenticationSettings.cs
@@ -0,0 +1,12 @@
+namespace CleanApiStarter.Configuration;
+
+public sealed class AuthenticationSettings
+{
+ [Required]
+ [ValidateObjectMembers]
+ public GoogleAuthenticationSettings Google { get; set; } = new();
+
+ [Required]
+ [ValidateObjectMembers]
+ public JwtAuthenticationSettings Jwt { get; set; } = new();
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Configuration/ConnectionStringSettings.cs b/src/CleanApiStarter.Configuration/ConnectionStringSettings.cs
index 1299016..deb6fbe 100644
--- a/src/CleanApiStarter.Configuration/ConnectionStringSettings.cs
+++ b/src/CleanApiStarter.Configuration/ConnectionStringSettings.cs
@@ -4,4 +4,4 @@ public sealed class ConnectionStringSettings
{
[Required]
public string Postgres { get; set; } = string.Empty;
-}
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Configuration/GlobalUsings.cs b/src/CleanApiStarter.Configuration/GlobalUsings.cs
index a2250c9..1fd17fc 100644
--- a/src/CleanApiStarter.Configuration/GlobalUsings.cs
+++ b/src/CleanApiStarter.Configuration/GlobalUsings.cs
@@ -2,4 +2,4 @@
global using Microsoft.Extensions.Configuration;
global using Microsoft.Extensions.DependencyInjection;
-global using Microsoft.Extensions.Options;
+global using Microsoft.Extensions.Options;
\ No newline at end of file
diff --git a/src/CleanApiStarter.Configuration/GoogleAuthenticationSettings.cs b/src/CleanApiStarter.Configuration/GoogleAuthenticationSettings.cs
new file mode 100644
index 0000000..1fda7db
--- /dev/null
+++ b/src/CleanApiStarter.Configuration/GoogleAuthenticationSettings.cs
@@ -0,0 +1,7 @@
+namespace CleanApiStarter.Configuration;
+
+public sealed class GoogleAuthenticationSettings
+{
+ [Required]
+ public string ClientId { get; set; } = string.Empty;
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Configuration/JwtAuthenticationSettings.cs b/src/CleanApiStarter.Configuration/JwtAuthenticationSettings.cs
new file mode 100644
index 0000000..9183996
--- /dev/null
+++ b/src/CleanApiStarter.Configuration/JwtAuthenticationSettings.cs
@@ -0,0 +1,17 @@
+namespace CleanApiStarter.Configuration;
+
+public sealed class JwtAuthenticationSettings
+{
+ [Required]
+ public string Issuer { get; set; } = string.Empty;
+
+ [Required]
+ public string Audience { get; set; } = string.Empty;
+
+ [Required]
+ [MinLength(32)]
+ public string SigningKey { get; set; } = string.Empty;
+
+ [Range(1, 1440)]
+ public int ExpirationMinutes { get; set; } = 60;
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Configuration/OptionsRegistrationExtensions.cs b/src/CleanApiStarter.Configuration/OptionsRegistrationExtensions.cs
index 6b767c7..051f517 100644
--- a/src/CleanApiStarter.Configuration/OptionsRegistrationExtensions.cs
+++ b/src/CleanApiStarter.Configuration/OptionsRegistrationExtensions.cs
@@ -16,4 +16,4 @@ public static IServiceCollection AddAppSettings(
return services;
}
-}
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Infrastructure/CleanApiStarter.Infrastructure.csproj b/src/CleanApiStarter.Infrastructure/CleanApiStarter.Infrastructure.csproj
index a814aa1..71d039f 100644
--- a/src/CleanApiStarter.Infrastructure/CleanApiStarter.Infrastructure.csproj
+++ b/src/CleanApiStarter.Infrastructure/CleanApiStarter.Infrastructure.csproj
@@ -11,8 +11,10 @@
-
-
+
+
+
+
diff --git a/src/CleanApiStarter.Infrastructure/Database/DatabaseConnectionFactory.cs b/src/CleanApiStarter.Infrastructure/Database/DatabaseConnectionFactory.cs
deleted file mode 100644
index b82d596..0000000
--- a/src/CleanApiStarter.Infrastructure/Database/DatabaseConnectionFactory.cs
+++ /dev/null
@@ -1,14 +0,0 @@
-namespace CleanApiStarter.Infrastructure.Database;
-
-public interface IDatabaseConnectionFactory
-{
- IDbConnection CreateConnection();
-}
-
-public class PostgresConnectionFactory(AppSettings appSettings) : IDatabaseConnectionFactory
-{
- public IDbConnection CreateConnection()
- {
- return new NpgsqlConnection(appSettings.ConnectionStrings.Postgres);
- }
-}
diff --git a/src/CleanApiStarter.Infrastructure/DependencyInjection.cs b/src/CleanApiStarter.Infrastructure/DependencyInjection.cs
index b2a5e19..72cd87e 100644
--- a/src/CleanApiStarter.Infrastructure/DependencyInjection.cs
+++ b/src/CleanApiStarter.Infrastructure/DependencyInjection.cs
@@ -1,12 +1,22 @@
namespace CleanApiStarter.Infrastructure;
-public static class DependencyInjection
-{
- public static IServiceCollection AddInfrastructure(this IServiceCollection services)
- {
- services.AddSingleton();
- services.AddScoped();
-
- return services;
+public static class DependencyInjection
+{
+ public static IServiceCollection AddInfrastructure(this IServiceCollection services)
+ {
+ services.AddDbContext((serviceProvider, options) =>
+ {
+ AppSettings appSettings = serviceProvider.GetRequiredService();
+ options.UseNpgsql(appSettings.ConnectionStrings.Postgres);
+ });
+
+ services.AddIdentityCore()
+ .AddRoles()
+ .AddEntityFrameworkStores();
+
+ services.AddScoped();
+ services.AddScoped();
+
+ return services;
}
-}
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Infrastructure/GlobalUsings.cs b/src/CleanApiStarter.Infrastructure/GlobalUsings.cs
index 0106a08..8e0a629 100644
--- a/src/CleanApiStarter.Infrastructure/GlobalUsings.cs
+++ b/src/CleanApiStarter.Infrastructure/GlobalUsings.cs
@@ -1,14 +1,21 @@
-global using System.Data;
+global using System.IdentityModel.Tokens.Jwt;
+global using System.Security.Claims;
+global using System.Text;
global using System.Text.Json;
-global using CleanApiStarter.Application.Interfaces;
+global using CleanApiStarter.Application.Features.Auth;
+global using CleanApiStarter.Application.Features.Words;
global using CleanApiStarter.Configuration;
global using CleanApiStarter.Domain.Entities;
-global using CleanApiStarter.Infrastructure.Database;
+global using CleanApiStarter.Infrastructure.Identity;
+global using CleanApiStarter.Infrastructure.Persistence;
global using CleanApiStarter.Infrastructure.Repositories;
-global using Dapper;
+global using Google.Apis.Auth;
+global using Microsoft.AspNetCore.Identity;
+global using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
+global using Microsoft.EntityFrameworkCore;
+global using Microsoft.EntityFrameworkCore.Metadata.Builders;
global using Microsoft.Extensions.DependencyInjection;
-
-global using Npgsql;
+global using Microsoft.IdentityModel.Tokens;
\ No newline at end of file
diff --git a/src/CleanApiStarter.Infrastructure/Identity/ApplicationUser.cs b/src/CleanApiStarter.Infrastructure/Identity/ApplicationUser.cs
new file mode 100644
index 0000000..2996a8e
--- /dev/null
+++ b/src/CleanApiStarter.Infrastructure/Identity/ApplicationUser.cs
@@ -0,0 +1,3 @@
+namespace CleanApiStarter.Infrastructure.Identity;
+
+public sealed class ApplicationUser : IdentityUser;
\ No newline at end of file
diff --git a/src/CleanApiStarter.Infrastructure/Identity/GoogleAuthService.cs b/src/CleanApiStarter.Infrastructure/Identity/GoogleAuthService.cs
new file mode 100644
index 0000000..d6e61ce
--- /dev/null
+++ b/src/CleanApiStarter.Infrastructure/Identity/GoogleAuthService.cs
@@ -0,0 +1,151 @@
+namespace CleanApiStarter.Infrastructure.Identity;
+
+public sealed class GoogleAuthService(
+ AppSettings appSettings,
+ UserManager userManager,
+ RoleManager roleManager) : IAuthService
+{
+ private const string GoogleLoginProvider = "Google";
+ private const string DefaultRole = "User";
+
+ public async Task SignInWithGoogleAsync(GoogleSignInDto signInDto, CancellationToken cancellationToken)
+ {
+ GoogleJsonWebSignature.Payload payload = await ValidateGoogleTokenAsync(signInDto.IdToken);
+ ApplicationUser user = await FindOrCreateUserAsync(payload, cancellationToken);
+ IList roles = await userManager.GetRolesAsync(user);
+ DateTimeOffset expiresAt = DateTimeOffset.UtcNow.AddMinutes(appSettings.Authentication.Jwt.ExpirationMinutes);
+
+ return new AuthTokenDto
+ {
+ AccessToken = CreateAccessToken(user, payload.Name, roles, expiresAt),
+ ExpiresAt = expiresAt
+ };
+ }
+
+ public Task GetCurrentUserAsync(ClaimsPrincipal principal, CancellationToken cancellationToken)
+ {
+ string userId = principal.FindFirstValue(ClaimTypes.NameIdentifier) ?? string.Empty;
+ string email = principal.FindFirstValue(ClaimTypes.Email) ?? string.Empty;
+ string name = principal.FindFirstValue(ClaimTypes.Name) ?? string.Empty;
+ string[] roles = principal.FindAll(ClaimTypes.Role)
+ .Select(claim => claim.Value)
+ .ToArray();
+
+ return Task.FromResult(new CurrentUserDto
+ {
+ UserId = userId,
+ Email = email,
+ Name = name,
+ Roles = roles
+ });
+ }
+
+ private async Task ValidateGoogleTokenAsync(string idToken)
+ {
+ GoogleJsonWebSignature.ValidationSettings validationSettings = new()
+ {
+ Audience = [appSettings.Authentication.Google.ClientId]
+ };
+
+ return await GoogleJsonWebSignature.ValidateAsync(idToken, validationSettings);
+ }
+
+ private async Task FindOrCreateUserAsync(
+ GoogleJsonWebSignature.Payload payload,
+ CancellationToken cancellationToken)
+ {
+ if (string.IsNullOrWhiteSpace(payload.Email) || !payload.EmailVerified)
+ {
+ throw new UnauthorizedAccessException("Google account email must be verified.");
+ }
+
+ ApplicationUser? user = await userManager.FindByLoginAsync(GoogleLoginProvider, payload.Subject);
+
+ if (user == null)
+ {
+ user = await userManager.FindByEmailAsync(payload.Email);
+ }
+
+ if (user == null)
+ {
+ user = new ApplicationUser
+ {
+ UserName = payload.Email,
+ Email = payload.Email,
+ EmailConfirmed = payload.EmailVerified
+ };
+
+ IdentityResult createResult = await userManager.CreateAsync(user);
+ ThrowIfFailed(createResult);
+ }
+
+ UserLoginInfo googleLogin = new(GoogleLoginProvider, payload.Subject, GoogleLoginProvider);
+ IList logins = await userManager.GetLoginsAsync(user);
+
+ if (!logins.Any(login => login.LoginProvider == GoogleLoginProvider && login.ProviderKey == payload.Subject))
+ {
+ IdentityResult loginResult = await userManager.AddLoginAsync(user, googleLogin);
+ ThrowIfFailed(loginResult);
+ }
+
+ await EnsureDefaultRoleAsync(user);
+
+ return user;
+ }
+
+ private async Task EnsureDefaultRoleAsync(ApplicationUser user)
+ {
+ if (!await roleManager.RoleExistsAsync(DefaultRole))
+ {
+ IdentityResult roleResult = await roleManager.CreateAsync(new IdentityRole(DefaultRole));
+ ThrowIfFailed(roleResult);
+ }
+
+ if (!await userManager.IsInRoleAsync(user, DefaultRole))
+ {
+ IdentityResult userRoleResult = await userManager.AddToRoleAsync(user, DefaultRole);
+ ThrowIfFailed(userRoleResult);
+ }
+ }
+
+ private string CreateAccessToken(
+ ApplicationUser user,
+ string? googleName,
+ IEnumerable roles,
+ DateTimeOffset expiresAt)
+ {
+ JwtAuthenticationSettings jwtSettings = appSettings.Authentication.Jwt;
+ SymmetricSecurityKey securityKey = new(Encoding.UTF8.GetBytes(jwtSettings.SigningKey));
+ SigningCredentials signingCredentials = new(securityKey, SecurityAlgorithms.HmacSha256);
+ List claims =
+ [
+ new(JwtRegisteredClaimNames.Sub, user.Id),
+ new(JwtRegisteredClaimNames.Jti, Guid.NewGuid().ToString()),
+ new(ClaimTypes.NameIdentifier, user.Id),
+ new(ClaimTypes.Email, user.Email ?? string.Empty),
+ new(ClaimTypes.Name, googleName ?? user.UserName ?? string.Empty)
+ ];
+
+ claims.AddRange(roles.Select(role => new Claim(ClaimTypes.Role, role)));
+
+ JwtSecurityToken token = new(
+ issuer: jwtSettings.Issuer,
+ audience: jwtSettings.Audience,
+ claims: claims,
+ expires: expiresAt.UtcDateTime,
+ signingCredentials: signingCredentials);
+
+ return new JwtSecurityTokenHandler().WriteToken(token);
+ }
+
+ private static void ThrowIfFailed(IdentityResult result)
+ {
+ if (result.Succeeded)
+ {
+ return;
+ }
+
+ string errors = string.Join("; ", result.Errors.Select(error => error.Description));
+ throw new InvalidOperationException(errors);
+ }
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Infrastructure/Persistence/ApplicationDbContext.cs b/src/CleanApiStarter.Infrastructure/Persistence/ApplicationDbContext.cs
new file mode 100644
index 0000000..b1d19b2
--- /dev/null
+++ b/src/CleanApiStarter.Infrastructure/Persistence/ApplicationDbContext.cs
@@ -0,0 +1,14 @@
+namespace CleanApiStarter.Infrastructure.Persistence;
+
+public sealed class ApplicationDbContext(DbContextOptions options)
+ : IdentityDbContext(options)
+{
+ public DbSet Words => Set();
+
+ protected override void OnModelCreating(ModelBuilder builder)
+ {
+ base.OnModelCreating(builder);
+
+ builder.ApplyConfigurationsFromAssembly(typeof(ApplicationDbContext).Assembly);
+ }
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Infrastructure/Persistence/Configuration/WordConfiguration.cs b/src/CleanApiStarter.Infrastructure/Persistence/Configuration/WordConfiguration.cs
new file mode 100644
index 0000000..61ee5f4
--- /dev/null
+++ b/src/CleanApiStarter.Infrastructure/Persistence/Configuration/WordConfiguration.cs
@@ -0,0 +1,40 @@
+namespace CleanApiStarter.Infrastructure.Persistence.Configuration;
+
+public sealed class WordConfiguration : IEntityTypeConfiguration
+{
+ public void Configure(EntityTypeBuilder builder)
+ {
+ builder.ToTable("words");
+
+ builder.HasKey(word => word.Id);
+
+ builder.Property(word => word.Id)
+ .HasColumnName("id");
+
+ builder.Property(word => word.Text)
+ .HasColumnName("text")
+ .HasMaxLength(100)
+ .IsRequired();
+
+ builder.Property(word => word.Meaning)
+ .HasColumnName("meaning")
+ .IsRequired();
+
+ builder.Property(word => word.Synonyms)
+ .HasColumnName("synonyms")
+ .HasColumnType("jsonb")
+ .HasConversion(
+ synonyms => JsonSerializer.Serialize(synonyms, JsonSerializerOptions.Default),
+ value => JsonSerializer.Deserialize>(value, JsonSerializerOptions.Default) ?? new List());
+
+ builder.Property(word => word.UsageExample)
+ .HasColumnName("usage_example")
+ .IsRequired();
+
+ builder.Property(word => word.CreatedAt)
+ .HasColumnName("created_at");
+
+ builder.Property(word => word.UpdatedAt)
+ .HasColumnName("updated_at");
+ }
+}
\ No newline at end of file
diff --git a/src/CleanApiStarter.Infrastructure/Repositories/WordRepository.cs b/src/CleanApiStarter.Infrastructure/Repositories/WordRepository.cs
index ce6b6cf..d2c6334 100644
--- a/src/CleanApiStarter.Infrastructure/Repositories/WordRepository.cs
+++ b/src/CleanApiStarter.Infrastructure/Repositories/WordRepository.cs
@@ -1,121 +1,44 @@
namespace CleanApiStarter.Infrastructure.Repositories;
-public class WordRepository(IDatabaseConnectionFactory connectionFactory) : IWordRepository
+public class WordRepository(ApplicationDbContext dbContext) : IWordRepository
{
public async Task AddWordAsync(Word word, CancellationToken cancellationToken)
{
- const string sql =
- """
- INSERT INTO words (id, text, meaning, synonyms, usage_example, created_at, updated_at)
- VALUES (@Id, @Text, @Meaning, @Synonyms::jsonb, @UsageExample, @CreatedAt, @UpdatedAt)
- RETURNING id
- """;
+ dbContext.Words.Add(word);
+ await dbContext.SaveChangesAsync(cancellationToken);
- using IDbConnection connection = connectionFactory.CreateConnection();
-
- var parameters = new
- {
- word.Id,
- word.Text,
- word.Meaning,
- Synonyms = JsonSerializer.Serialize(word.Synonyms),
- word.UsageExample,
- word.CreatedAt,
- word.UpdatedAt
- };
-
- Guid id = await connection.ExecuteScalarAsync(sql, parameters);
- return id;
+ return word.Id;
}
public async Task GetWordByIdAsync(Guid id, CancellationToken cancellationToken)
{
- const string sql =
- """
- SELECT id, text, meaning, synonyms::text as SynonymsJson, usage_example as UsageExample, created_at as CreatedAt, updated_at as UpdatedAt
- FROM words
- WHERE id = @Id
- """;
-
- using IDbConnection connection = connectionFactory.CreateConnection();
- WordRow? word = await connection.QuerySingleOrDefaultAsync(sql, new { Id = id });
-
- return word?.ToDomain();
+ return await dbContext.Words
+ .AsNoTracking()
+ .SingleOrDefaultAsync(word => word.Id == id, cancellationToken);
}
public async Task> GetAllWordsAsync(CancellationToken cancellationToken)
{
- const string sql =
- """
- SELECT id, text, meaning, synonyms::text as SynonymsJson, usage_example as UsageExample, created_at as CreatedAt, updated_at as UpdatedAt
- FROM words
- """;
-
- using IDbConnection connection = connectionFactory.CreateConnection();
- IEnumerable words = await connection.QueryAsync(sql);
-
- return words.Select(word => word.ToDomain());
+ return await dbContext.Words
+ .AsNoTracking()
+ .OrderBy(word => word.Text)
+ .ToListAsync(cancellationToken);
}
public async Task UpdateWordAsync(Word word, CancellationToken cancellationToken)
{
- const string sql =
- """
- UPDATE words
- SET text = @Text,
- meaning = @Meaning,
- synonyms = @Synonyms,
- usage_example = @UsageExample,
- updated_at = @UpdatedAt
- WHERE id = @Id
- """;
+ dbContext.Words.Update(word);
+ int rowsAffected = await dbContext.SaveChangesAsync(cancellationToken);
- using IDbConnection connection = connectionFactory.CreateConnection();
- var parameters = new
- {
- word.Id,
- word.Text,
- word.Meaning,
- Synonyms = JsonSerializer.Serialize(word.Synonyms),
- word.UsageExample,
- word.UpdatedAt
- };
-
- int rowsAffected = await connection.ExecuteAsync(sql, parameters);
return rowsAffected > 0;
}
public async Task DeleteWordAsync(Guid id, CancellationToken cancellationToken)
{
- const string sql = "DELETE FROM words WHERE id = @Id";
+ int rowsAffected = await dbContext.Words
+ .Where(word => word.Id == id)
+ .ExecuteDeleteAsync(cancellationToken);
- using IDbConnection connection = connectionFactory.CreateConnection();
- int rowsAffected = await connection.ExecuteAsync(sql, new { Id = id });
return rowsAffected > 0;
}
-
- private sealed class WordRow
- {
- public Guid Id { get; init; }
- public string Text { get; init; } = string.Empty;
- public string Meaning { get; init; } = string.Empty;
- public string SynonymsJson { get; init; } = string.Empty;
- public string UsageExample { get; init; } = string.Empty;
- public DateTime CreatedAt { get; init; }
- public DateTime? UpdatedAt { get; init; }
-
- public Word ToDomain()
- {
- return new Word
- {
- Id = Id,
- Text = Text,
- Meaning = Meaning,
- Synonyms = JsonSerializer.Deserialize>(SynonymsJson) ?? [],
- UsageExample = UsageExample,
- CreatedAt = CreatedAt,
- UpdatedAt = UpdatedAt
- };
- }
- }
}
\ No newline at end of file
diff --git a/tests/CleanApiStarter.UnitTests/Controllers/WordsControllerTests.cs b/tests/CleanApiStarter.UnitTests/Controllers/WordsControllerTests.cs
deleted file mode 100644
index 356aa00..0000000
--- a/tests/CleanApiStarter.UnitTests/Controllers/WordsControllerTests.cs
+++ /dev/null
@@ -1,131 +0,0 @@
-// using CleanApiStarter.Api.Controllers;
-// using CleanApiStarter.Application.Interfaces;
-// using CleanApiStarter.Application.Models;
-// using AutoFixture.Xunit3;
-// using FluentAssertions;
-// using Microsoft.AspNetCore.Mvc;
-// using NSubstitute;
-// using Xunit;
-//
-// namespace CleanApiStarter.UnitTests.Controllers;
-//
-// public class WordsControllerTests
-// {
-// private readonly IWordService _wordService;
-// private readonly WordsController _sut;
-//
-// public WordsControllerTests()
-// {
-// _wordService = Substitute.For();
-// _sut = new WordsController(_wordService);
-// }
-//
-// [Theory, AutoData]
-// public async Task CreateWord_ShouldReturnCreatedAtAction(CreateWordDto wordDto, Guid wordId)
-// {
-// // Arrange
-// _wordService.AddWordAsync(wordDto).Returns(wordId);
-//
-// // Act
-// var result = await _sut.CreateWord(wordDto);
-//
-// // Assert
-// var createdAtActionResult = result.Result.Should().BeOfType().Subject;
-// createdAtActionResult.ActionName.Should().Be(nameof(WordsController.GetWord));
-// createdAtActionResult.RouteValues!.Should().ContainKey("id").WhoseValue.Should().Be(wordId);
-// createdAtActionResult.Value.Should().Be(wordId);
-// }
-//
-// [Theory, AutoData]
-// public async Task GetWord_WhenWordExists_ShouldReturnOkWithWord(Guid wordId, WordDto wordDto)
-// {
-// // Arrange
-// _wordService.GetWordByIdAsync(wordId).Returns(wordDto);
-//
-// // Act
-// var result = await _sut.GetWord(wordId);
-//
-// // Assert
-// var okResult = result.Result.Should().BeOfType().Subject;
-// okResult.Value.Should().Be(wordDto);
-// }
-//
-// [Theory, AutoData]
-// public async Task GetWord_WhenWordDoesNotExist_ShouldReturnNotFound(Guid wordId)
-// {
-// // Arrange
-// _wordService.GetWordByIdAsync(wordId).Returns((WordDto?)null);
-//
-// // Act
-// var result = await _sut.GetWord(wordId);
-//
-// // Assert
-// result.Result.Should().BeOfType();
-// }
-//
-// [Theory, AutoData]
-// public async Task GetAllWords_ShouldReturnOkWithAllWords(List words)
-// {
-// // Arrange
-// _wordService.GetAllWordsAsync().Returns(words);
-//
-// // Act
-// var result = await _sut.GetAllWords();
-//
-// // Assert
-// var okResult = result.Result.Should().BeOfType().Subject;
-// okResult.Value.Should().Be(words);
-// }
-//
-// [Theory, AutoData]
-// public async Task UpdateWord_WhenWordExists_ShouldReturnNoContent(Guid wordId, CreateWordDto updateDto)
-// {
-// // Arrange
-// _wordService.UpdateWordAsync(wordId, updateDto).Returns(true);
-//
-// // Act
-// var result = await _sut.UpdateWord(wordId, updateDto);
-//
-// // Assert
-// result.Should().BeOfType();
-// }
-//
-// [Theory, AutoData]
-// public async Task UpdateWord_WhenWordDoesNotExist_ShouldReturnNotFound(Guid wordId, CreateWordDto updateDto)
-// {
-// // Arrange
-// _wordService.UpdateWordAsync(wordId, updateDto).Returns(false);
-//
-// // Act
-// var result = await _sut.UpdateWord(wordId, updateDto);
-//
-// // Assert
-// result.Should().BeOfType();
-// }
-//
-// [Theory, AutoData]
-// public async Task DeleteWord_WhenWordExists_ShouldReturnNoContent(Guid wordId)
-// {
-// // Arrange
-// _wordService.DeleteWordAsync(wordId).Returns(true);
-//
-// // Act
-// var result = await _sut.DeleteWord(wordId);
-//
-// // Assert
-// result.Should().BeOfType();
-// }
-//
-// [Theory, AutoData]
-// public async Task DeleteWord_WhenWordDoesNotExist_ShouldReturnNotFound(Guid wordId)
-// {
-// // Arrange
-// _wordService.DeleteWordAsync(wordId).Returns(false);
-//
-// // Act
-// var result = await _sut.DeleteWord(wordId);
-//
-// // Assert
-// result.Should().BeOfType();
-// }
-// }
\ No newline at end of file
diff --git a/tests/CleanApiStarter.UnitTests/Repositories/WordRepositoryTests.cs b/tests/CleanApiStarter.UnitTests/Repositories/WordRepositoryTests.cs
deleted file mode 100644
index 50d024d..0000000
--- a/tests/CleanApiStarter.UnitTests/Repositories/WordRepositoryTests.cs
+++ /dev/null
@@ -1,61 +0,0 @@
-// using System.Data;
-// using AutoFixture.Xunit3;
-// using CleanApiStarter.Domain.Entities;
-// using FluentAssertions;
-// using CleanApiStarter.Infrastructure.Database;
-// using CleanApiStarter.Infrastructure.Repositories;
-// using NSubstitute;
-// using Xunit;
-//
-// namespace CleanApiStarter.UnitTests.Repositories;
-//
-// public class WordRepositoryTests
-// {
-// private readonly IDatabaseConnectionFactory _connectionFactory;
-// private readonly IDbConnection _connection;
-// private readonly WordRepository _sut;
-//
-// public WordRepositoryTests()
-// {
-// _connection = Substitute.For();
-// _connectionFactory = Substitute.For();
-// _connectionFactory.CreateConnection().Returns(_connection);
-//
-// _sut = new WordRepository(_connectionFactory);
-// }
-//
-// [Theory, AutoData]
-// public async Task AddWordAsync_ShouldOpenConnectionAndExecuteCommand(Word word)
-// {
-// // This test is a basic structure to show how to mock Dapper
-// // Full implementation would require more complex mocking of connection and command
-//
-// // Arrange
-// var expectedId = word.Id;
-//
-// // Act
-// await _sut.AddWordAsync(word);
-//
-// // Assert
-// _connectionFactory.Received(1).CreateConnection();
-// }
-//
-// [Theory, AutoData]
-// public async Task GetWordByIdAsync_ShouldOpenConnectionAndExecuteQuery(Guid id)
-// {
-// // This test is a basic structure to show how to mock Dapper
-// // Full implementation would require more complex mocking of connection and query
-//
-// // Arrange
-//
-// // Act
-// await _sut.GetWordByIdAsync(id);
-//
-// // Assert
-// _connectionFactory.Received(1).CreateConnection();
-// }
-//
-// // Additional tests would follow the same pattern
-// // For a real implementation, you would need to mock Dapper's extension methods
-// // which is more complex and may require a test database or more sophisticated mocking
-// }
\ No newline at end of file
diff --git a/tests/CleanApiStarter.UnitTests/Services/WordServiceTests.cs b/tests/CleanApiStarter.UnitTests/Services/WordServiceTests.cs
deleted file mode 100644
index 601e4a5..0000000
--- a/tests/CleanApiStarter.UnitTests/Services/WordServiceTests.cs
+++ /dev/null
@@ -1,139 +0,0 @@
-// using CleanApiStarter.Application.Interfaces;
-// using CleanApiStarter.Application.Models;
-// using CleanApiStarter.Application.Services;
-//
-// using CleanApiStarter.Domain.Entities;
-//
-// using NSubstitute;
-//
-// using Shouldly;
-//
-// using Xunit;
-//
-// namespace CleanApiStarter.UnitTests.Services;
-//
-// public class WordServiceTests
-// {
-// private readonly IWordRepository _wordRepository;
-// private readonly WordService _sut;
-//
-// public WordServiceTests()
-// {
-// _wordRepository = Substitute.For();
-// _sut = new WordService(_wordRepository);
-// }
-//
-// [Theory, AutoData]
-// public async Task AddWordAsync_ShouldMapDtoToDomainAndCallRepository(CreateWordDto wordDto)
-// {
-// // Arrange
-// var expectedId = Guid.NewGuid();
-// _wordRepository.AddWordAsync(Arg.Any()).Returns(expectedId);
-//
-// // Act
-// var result = await _sut.AddWordAsync(wordDto);
-//
-// // Assert
-// result.ShouldBe(expectedId);
-// await _wordRepository.Received(1).AddWordAsync(Arg.Is(w =>
-// w.Text == wordDto.Text &&
-// w.Meaning == wordDto.Meaning &&
-// w.Synonyms.SequenceEqual(wordDto.Synonyms) &&
-// w.UsageExample == wordDto.UsageExample));
-// }
-//
-// [Theory, AutoData]
-// public async Task GetWordByIdAsync_WhenWordExists_ShouldReturnMappedDto(Guid id, Word word)
-// {
-// // Arrange
-// _wordRepository.GetWordByIdAsync(id).Returns(word);
-//
-// // Act
-// var result = await _sut.GetWordByIdAsync(id);
-//
-// // Assert
-// result.Should().NotBeNull();
-// result!.Id.Should().Be(word.Id);
-// result.Text.Should().Be(word.Text);
-// result.Meaning.Should().Be(word.Meaning);
-// result.Synonyms.Should().BeEquivalentTo(word.Synonyms);
-// result.UsageExample.Should().Be(word.UsageExample);
-// }
-//
-// [Theory, AutoData]
-// public async Task GetWordByIdAsync_WhenWordDoesNotExist_ShouldReturnNull(Guid id)
-// {
-// // Arrange
-// _wordRepository.GetWordByIdAsync(id).Returns((Word?)null);
-//
-// // Act
-// var result = await _sut.GetWordByIdAsync(id);
-//
-// // Assert
-// result.Should().BeNull();
-// }
-//
-// [Theory, AutoData]
-// public async Task GetAllWordsAsync_ShouldReturnMappedDtos(List words)
-// {
-// // Arrange
-// _wordRepository.GetAllWordsAsync().Returns(words);
-//
-// // Act
-// var result = await _sut.GetAllWordsAsync();
-//
-// // Assert
-// result.Should().HaveCount(words.Count);
-// result.Select(dto => dto.Id).Should().BeEquivalentTo(words.Select(w => w.Id));
-// }
-//
-// [Theory, AutoData]
-// public async Task UpdateWordAsync_WhenWordExists_ShouldUpdateAndReturnTrue(Guid id, CreateWordDto updateDto, Word existingWord)
-// {
-// // Arrange
-// existingWord.Id = id;
-// _wordRepository.GetWordByIdAsync(id).Returns(existingWord);
-// _wordRepository.UpdateWordAsync(Arg.Any()).Returns(true);
-//
-// // Act
-// var result = await _sut.UpdateWordAsync(id, updateDto);
-//
-// // Assert
-// result.Should().BeTrue();
-// await _wordRepository.Received(1).UpdateWordAsync(Arg.Is(w =>
-// w.Id == id &&
-// w.Text == updateDto.Text &&
-// w.Meaning == updateDto.Meaning &&
-// w.Synonyms.SequenceEqual(updateDto.Synonyms) &&
-// w.UsageExample == updateDto.UsageExample &&
-// w.UpdatedAt != null));
-// }
-//
-// [Theory, AutoData]
-// public async Task UpdateWordAsync_WhenWordDoesNotExist_ShouldReturnFalse(Guid id, CreateWordDto updateDto)
-// {
-// // Arrange
-// _wordRepository.GetWordByIdAsync(id).Returns((Word?)null);
-//
-// // Act
-// var result = await _sut.UpdateWordAsync(id, updateDto);
-//
-// // Assert
-// result.Should().BeFalse();
-// await _wordRepository.DidNotReceive().UpdateWordAsync(Arg.Any());
-// }
-//
-// [Theory, AutoData]
-// public async Task DeleteWordAsync_ShouldCallRepositoryAndReturnResult(Guid id, bool expectedResult)
-// {
-// // Arrange
-// _wordRepository.DeleteWordAsync(id).Returns(expectedResult);
-//
-// // Act
-// var result = await _sut.DeleteWordAsync(id);
-//
-// // Assert
-// result.Should().Be(expectedResult);
-// await _wordRepository.Received(1).DeleteWordAsync(id);
-// }
-// }
\ No newline at end of file
From d4111733c7b77243b15609cb0bf70e517e95d6cf Mon Sep 17 00:00:00 2001
From: cbjpdev <42979311+cstacklab@users.noreply.github.com>
Date: Fri, 1 May 2026 10:10:16 +0800
Subject: [PATCH 06/33] implement pagination and validation for word endpoints,
add response compression and request ID middleware
---
AGENTS.md | 20 ++++++---
Directory.Packages.props | 8 +++-
README.md | 7 +++
src/CleanApiStarter.Api/Api.http | 5 ++-
.../CleanApiStarter.Api.csproj | 2 +
.../Endpoints/GoogleLoginPage.cs | 39 +++++++++++++++-
src/CleanApiStarter.Api/Endpoints/V1/Words.cs | 9 ++--
src/CleanApiStarter.Api/Endpoints/V2/Words.cs | 16 ++++---
src/CleanApiStarter.Api/GlobalUsings.cs | 5 ++-
src/CleanApiStarter.Api/Program.cs | 38 ++++++++++------
.../CleanApiStarter.Application.csproj | 2 +
.../Common/Models/ArrayResult.cs | 8 ++++
.../Common/Models/PaginatedQuery.cs | 8 ++++
.../Common/Models/PaginatedQueryValidator.cs | 13 ++++++
.../Common/Models/PaginatedResult.cs | 27 +++++++++++
.../DependencyInjection.cs | 2 +
.../Features/Auth/GoogleSignInDtoValidator.cs | 10 +++++
.../Features/Words/CreateWordDtoValidator.cs | 24 ++++++++++
.../Features/Words/IWordRepository.cs | 2 +-
.../Features/Words/IWordService.cs | 2 +-
.../Features/Words/WordService.cs | 16 ++++---
.../GlobalUsings.cs | 3 ++
.../AspNetCoreDefaultServices.cs | 37 ++++++++++++++-
.../CleanApiStarter.AspNetCore.csproj | 3 ++
src/CleanApiStarter.AspNetCore/Extensions.cs | 3 ++
.../GlobalUsings.cs | 13 ++++--
.../RequestIdMiddleware.cs | 23 ++++++++++
.../ValidationFilter.cs | 45 +++++++++++++++++++
.../WebApplicationExtensions.cs | 3 +-
.../GlobalUsings.cs | 1 +
.../Repositories/WordRepository.cs | 19 ++++++--
31 files changed, 362 insertions(+), 51 deletions(-)
create mode 100644 src/CleanApiStarter.Application/Common/Models/ArrayResult.cs
create mode 100644 src/CleanApiStarter.Application/Common/Models/PaginatedQuery.cs
create mode 100644 src/CleanApiStarter.Application/Common/Models/PaginatedQueryValidator.cs
create mode 100644 src/CleanApiStarter.Application/Common/Models/PaginatedResult.cs
create mode 100644 src/CleanApiStarter.Application/Features/Auth/GoogleSignInDtoValidator.cs
create mode 100644 src/CleanApiStarter.Application/Features/Words/CreateWordDtoValidator.cs
create mode 100644 src/CleanApiStarter.AspNetCore/RequestIdMiddleware.cs
create mode 100644 src/CleanApiStarter.AspNetCore/ValidationFilter.cs
diff --git a/AGENTS.md b/AGENTS.md
index edbeebc..9e6e59d 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -51,11 +51,19 @@ This repository is a Clean Architecture API starter template named `CleanApiStar
- Organize the `Application` project by feature. Put feature-specific contracts, DTOs, and application services under folders such as `Application/Features/Words` or `Application/Features/Auth`.
- Do not create generic `Application/Services` or `Application/Models` folders for feature-specific code.
- Keep cross-cutting application abstractions under `Application/Common`, for example `Application/Common/Interfaces`.
+- Return single resources as their DTO object directly.
+- Use `ArrayResult` instead of returning raw arrays from non-paginated list endpoints.
+- Use `PaginatedQuery` for paginated request parameters and return `PaginatedResult` directly for paginated collection responses.
+- Use FluentValidation for request validation. Put validators beside feature request models in `Application`, and rely on the shared Minimal API validation endpoint filter in `CleanApiStarter.AspNetCore`. FluentValidation failures should return `422 Unprocessable Entity`.
+- Do not use DataAnnotations for application request validation.
- Use Scalar, not Swagger/Swashbuckle.
-- Use `Microsoft.AspNetCore.OpenApi` with:
- - `builder.Services.AddOpenApi();`
- - `app.MapOpenApi();`
- - `app.MapScalarApiReference();`
+- Use the .NET 10 API versioning/OpenAPI setup from the Microsoft .NET blog:
+ - `Asp.Versioning.Http` v10
+ - `Asp.Versioning.Mvc.ApiExplorer` v10
+ - `Asp.Versioning.OpenApi`
+ - `builder.Services.AddApiVersioning(...).AddApiExplorer(...).AddOpenApi();`
+ - `app.MapOpenApi().WithDocumentPerVersion();`
+ - `app.MapScalarApiReference(...)` configured from `app.DescribeApiVersions()`
- Do not add `Swashbuckle.AspNetCore`.
- Cancellation tokens are explicit:
- Do not use `CancellationToken cancellationToken = default` in service or repository contracts.
@@ -97,6 +105,8 @@ This repository is a Clean Architecture API starter template named `CleanApiStar
- `app.MapDefaultEndpoints();`
- Shared middleware such as HTTP request logging belongs in `CleanApiStarter.AspNetCore`, not duplicated inside each API project.
- Keep OpenTelemetry logs configured to include scopes, formatted messages, and parsed state values so structured message-template properties show up in Aspire.
+- Responses should include `X-Request-ID` with the current trace id, configured centrally in `CleanApiStarter.AspNetCore`.
+- Response compression should be configured centrally in `CleanApiStarter.AspNetCore` with Brotli and gzip providers.
- Use structured logging message templates instead of interpolated log strings. Prefer stable property names like `{WordId}` and `{WordCount}`.
- Register root settings once with `AddAppSettings(builder.Configuration)`, then inject `AppSettings` directly when services need configuration values.
- Do not add generic options registration helpers until the template has multiple real options sections that need them.
@@ -111,7 +121,7 @@ This repository is a Clean Architecture API starter template named `CleanApiStar
- Use built-in Minimal API mapping methods with explicit `.WithName(...)`; do not add custom `MapGet`/`MapPost` overloads that shadow framework methods.
- API versions are selected with the optional `X-Api-Version` request header. Missing versions default to v1.
- Endpoint groups should declare `MajorVersion` to match their folder, for example `V1` uses `1` and `V2` uses `2`.
-- Endpoint names must be globally unique across versions. Prefer names suffixed with the version, such as `GetAllWordsV1` and `GetAllWordsV2`.
+- Endpoint names must be globally unique across versions. Prefer names suffixed with the version, such as `GetWordsV1` and `GetWordsV2`.
- Do not reintroduce MVC controllers unless the template intentionally changes direction.
## Authentication
diff --git a/Directory.Packages.props b/Directory.Packages.props
index 601f3d5..fa34cb3 100644
--- a/Directory.Packages.props
+++ b/Directory.Packages.props
@@ -10,15 +10,19 @@
-
+
+
+
+
+
-
+
diff --git a/README.md b/README.md
index 5a2c448..005a459 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,9 @@ A Clean Architecture API starter template for .NET, Aspire, PostgreSQL, and Open
The API uses Minimal APIs with endpoint group classes. `CleanApiStarter.AspNetCore` discovers endpoint groups from the API assembly so `Program.cs` stays small while routes remain easy to find.
API versions are selected with the optional `X-Api-Version` request header. Requests without a version use v1 by default. Endpoint groups live under version folders such as `Endpoints/V1` and `Endpoints/V2`.
+OpenAPI documents are generated per API version and shown in Scalar with a version selector.
+
+Collection endpoints return an `ArrayResult` envelope when they are not paginated. Paginated endpoints accept `limit` and `offset` query parameters and return `PaginatedResult` metadata with the items. Single-resource endpoints return the resource object directly.
## Authentication
@@ -59,6 +62,8 @@ After the dashboard is running, send requests to the API through Scalar or anoth
- Logs show structured application and framework log entries. The word use cases emit fields such as `WordId`, `SynonymCount`, `WordCount`, and `UpdateSucceeded`.
- Request logs show method, path, response status code, duration, and `UserId` without logging request or response bodies. `CleanApiStarter.AspNetCore` keeps the `Microsoft.AspNetCore.HttpLogging` category at `Information` even when broader ASP.NET Core logs are filtered to `Warning`.
+- Responses include an `X-Request-ID` header containing the current OpenTelemetry trace id, which can be used to correlate API responses with Aspire traces and logs.
+- Responses support Brotli and gzip compression when clients send an `Accept-Encoding` header.
- Traces show incoming HTTP requests and PostgreSQL commands from Npgsql.
- Metrics show ASP.NET Core, HTTP client, and .NET runtime measurements.
- `/version` exposes the running application version.
@@ -72,6 +77,8 @@ Use structured logging message templates instead of interpolated log strings. Pr
Configuration classes live in `CleanApiStarter.Configuration`. Register root settings once with `AddAppSettings(builder.Configuration)`, then inject `AppSettings` directly where configuration values are needed.
+Request validation uses FluentValidation. Validators live beside their feature request models in the `Application` project and are executed by a Minimal API endpoint filter from `CleanApiStarter.AspNetCore`. FluentValidation failures return `422 Unprocessable Entity`.
+
### Run with Docker Compose Only
If you want to run PostgreSQL without Aspire:
diff --git a/src/CleanApiStarter.Api/Api.http b/src/CleanApiStarter.Api/Api.http
index 7deb1e4..66e410b 100644
--- a/src/CleanApiStarter.Api/Api.http
+++ b/src/CleanApiStarter.Api/Api.http
@@ -1,8 +1,9 @@
@CleanApiStarter_Api_HostAddress = https://localhost:7285
@AccessToken = paste-api-jwt-here
-GET {{CleanApiStarter_Api_HostAddress}}/api/words
+GET {{CleanApiStarter_Api_HostAddress}}/api/words?limit=20&offset=0
Accept: application/json
+Authorization: Bearer {{AccessToken}}
###
@@ -34,7 +35,7 @@ Authorization: Bearer {{AccessToken}}
###
-GET {{CleanApiStarter_Api_HostAddress}}/api/words
+GET {{CleanApiStarter_Api_HostAddress}}/api/words?limit=20&offset=0
Accept: application/json
X-Api-Version: 2.0
Authorization: Bearer {{AccessToken}}
diff --git a/src/CleanApiStarter.Api/CleanApiStarter.Api.csproj b/src/CleanApiStarter.Api/CleanApiStarter.Api.csproj
index 47c56e1..c710c1c 100644
--- a/src/CleanApiStarter.Api/CleanApiStarter.Api.csproj
+++ b/src/CleanApiStarter.Api/CleanApiStarter.Api.csproj
@@ -7,6 +7,8 @@
+
+
diff --git a/src/CleanApiStarter.Api/Endpoints/GoogleLoginPage.cs b/src/CleanApiStarter.Api/Endpoints/GoogleLoginPage.cs
index e57f2ec..a36d7cd 100644
--- a/src/CleanApiStarter.Api/Endpoints/GoogleLoginPage.cs
+++ b/src/CleanApiStarter.Api/Endpoints/GoogleLoginPage.cs
@@ -24,6 +24,10 @@ public static WebApplication MapGoogleLoginPage(this WebApplication app)
@@ -34,10 +38,16 @@ public static WebApplication MapGoogleLoginPage(this WebApplication app)
data-callback="handleCredentialResponse">
- API JWT
+
Sign in with Google to generate a token.