Backend · Any coding agent
.NET 10 & C# 14 Minimal APIs ARCHITECTURE.md
An ARCHITECTURE.md for .NET 10 & C# 14 Minimal APIs: module responsibilities, data flow and the boundaries code changes must keep.
- Path
- ARCHITECTURE.md
- Loads
- Read when referenced
- Format
- Markdown (.md)
- Used by
- Any coding agent
What this file tells the agent
ARCHITECTURE.md describes module responsibilities, state boundaries and data flow, so a coding agent knows where code belongs before it changes anything. Point to it from CLAUDE.md or AGENTS.md so agents read it.
- Use current C# features: primary constructors, collection expressions, file-scoped namespaces, C# 14's field keyword, and nullable reference types (#nullable enable).
- Structure lightweight microservices with ASP.NET Core Minimal APIs using typed route groups and TypedResults return values.
- Enforce AsNoTracking() on read-only EF Core queries to eliminate memory overhead from change trackers.
- Validate request payloads using FluentValidation or MiniValidation before executing business logic.
- Use IHttpClientFactory with typed resilience pipelines (Polly) for outbound HTTP calls.
Code to avoid, and what to write instead
The rule steers the agent away from the left and toward the right.
// Discouraged: Nested namespaces, missing AsNoTracking, untyped object returns
namespace App.Controllers
{
public class UsersController : Controller
{
[HttpGet]
public IActionResult GetUser(Guid id)
{
var user = _context.Users.Find(id); // Untracked query tracking all state!
return Ok(user);
}
}
}namespace App.Features.Users;
using Microsoft.AspNetCore.Http.HttpResults;
using Microsoft.EntityFrameworkCore;
public record CreateUserRequest(string Email, string FullName);
public record UserDto(Guid Id, string Email, string FullName);
public static class UserEndpoints
{
public static RouteGroupBuilder MapUserEndpoints(this RouteGroupBuilder group)
{
group.MapGet("/{id:guid}", async Task<Results<Ok<UserDto>, NotFound>> (Guid id, AppDbContext db) =>
{
var user = await db.Users
.AsNoTracking()
.Where(u => u.Id == id)
.Select(u => new UserDto(u.Id, u.Email, u.FullName))
.FirstOrDefaultAsync();
return user is not null ? TypedResults.Ok(user) : TypedResults.NotFound();
});
return group;
}
}Install it in one command
- 01
Go to your project root
The file goes at ARCHITECTURE.md, relative to the root.
- 02
Download the file
Run the command on the right. It downloads this preset and writes the file.
- 03
Make sure it gets used
Agents read it when your CLAUDE.md or AGENTS.md points to it. Add a line such as "Read ARCHITECTURE.md before structural changes".
$ curl -fsSL "https://www.devscratchpad.tech/api/raw/architecture-md/csharp-dotnet-10" -o "ARCHITECTURE.md"
writes ARCHITECTURE.md
ARCHITECTURE.md
To write the file from your own code instead, use Read your code or Convert Legacy Rules in the editor above.
More for .NET 10 & C# 14 Minimal APIs
Questions
- What belongs in ARCHITECTURE.md?
- How the main modules relate, how state and data flow, and the boundaries every change must keep.
- How does ARCHITECTURE.md help AI agents?
- It tells them where code belongs and which boundaries to keep, so they are less likely to add circular dependencies or skip layers. Point to it from CLAUDE.md or AGENTS.md so they read it.