Implement Order API with CRUD operations and documentation for GitHub Copilot (#23)

Author: skyarkitekten

.github/copilot-instructions.md

@@ -0,0 +1,7 @@
+# Instructions for GitHub Copilot
+
+## Source Control
+
+- We use GitHub Issues for all work tracking.
+- We use Pull Requests to facilitate code reviews.
+- We use Trunk-based development and short term feature branches. Featur branches should start with `feat/`, for example a feature called "add login" would be `feat/add-login`.

samples/Orders/Orders.Api/Controllers/OrderController.cs

@@ -0,0 +1,37 @@
+using Microsoft.AspNetCore.Mvc;
+using Orders.Domain;
+
+namespace Orders.Api.Controllers;
+
+[ApiController]
+[Route("api/[controller]")]
+public class OrderController : ControllerBase
+{
+    private readonly IOrderRepository _orderRepository;
+    private readonly ILogger<OrderController> _logger;
+
+    public OrderController(IOrderRepository orderRepository, ILogger<OrderController> logger)
+    {
+        _orderRepository = orderRepository;
+        _logger = logger;
+    }
+
+    [HttpGet("{id}")]
+    public async Task<IActionResult> GetOrderById(int id)
+    {
+        var order = await _orderRepository.GetOrderByIdAsync(id);
+        if (order == null)
+        {
+            return NotFound();
+        }
+        return Ok(order);
+    }
+
+    [HttpPost]
+    public async Task<IActionResult> CreateOrder([FromBody] Order order)
+    {
+        await _orderRepository.AddOrderAsync(order);
+        await _orderRepository.SaveChangesAsync();
+        return CreatedAtAction(nameof(GetOrderById), new { id = order.Id }, order);
+    }
+}

samples/Orders/Orders.Api/Orders.Api.csproj

@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.0" />
+    <PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.3.0" />
+    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.10.0" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.0.0-rc9.9" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.0.0-rc9.9" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="7.2.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Orders.Domain\Orders.Domain.csproj" />
+  </ItemGroup>
+
+</Project>

samples/Orders/Orders.Api/Orders.Api.http

@@ -0,0 +1,6 @@
+@Orders.Api_HostAddress = http://localhost:5099
+
+GET {{Orders.Api_HostAddress}}/weatherforecast/
+Accept: application/json
+
+###

samples/Orders/Orders.Api/Program.cs

@@ -0,0 +1,28 @@
+using Orders.Domain;
+using Orders.Api.Repositories;
+using OpenTelemetry.Trace;
+
+var builder = WebApplication.CreateBuilder(args);
+
+// Add services to the container.
+builder.Services.AddControllers();
+builder.Services.AddScoped<IOrderRepository, OrderRepository>();
+builder.Services.AddOpenApi();
+
+var app = builder.Build();
+
+// Configure the HTTP request pipeline.
+if (app.Environment.IsDevelopment())
+{
+    app.UseDeveloperExceptionPage();
+    app.UseSwagger();
+    app.UseSwaggerUI();
+    app.MapOpenApi();
+}
+
+app.UseHttpsRedirection();
+app.UseAuthorization();
+
+app.MapControllers();
+
+app.Run();

samples/Orders/Orders.Api/Properties/launchSettings.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json.schemastore.org/launchsettings.json",
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "http://localhost:5099",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "https://localhost:7218;http://localhost:5099",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

samples/Orders/Orders.Api/Repositories/OrderRepository.cs

@@ -0,0 +1,26 @@
+using Orders.Domain;
+
+namespace Orders.Api.Repositories;
+
+public class OrderRepository : IOrderRepository
+{
+    private readonly List<Order> _orders = new();
+
+    public Task<Order> GetOrderByIdAsync(int id)
+    {
+        var order = _orders.FirstOrDefault(o => o.Id == id);
+        return Task.FromResult(order);
+    }
+
+    public Task AddOrderAsync(Order order)
+    {
+        _orders.Add(order);
+        return Task.CompletedTask;
+    }
+
+    public Task SaveChangesAsync()
+    {
+        // In-memory implementation, no action needed
+        return Task.CompletedTask;
+    }
+}

samples/Orders/Orders.Api/appsettings.Development.json

@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}

samples/Orders/Orders.Api/appsettings.json

@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}

samples/Orders/Orders.Domain/Order.cs

@@ -0,0 +1,27 @@
+namespace Orders.Domain;
+
+public class Order
+{
+    public int Id { get; set; }
+    public DateTime OrderDate { get; set; }
+    public string CustomerName { get; set; }
+    public List<OrderItem> Items { get; set; } = new List<OrderItem>();
+
+    public void AddOrderItem(OrderItem item)
+    {
+        Items.Add(item);
+    }
+
+    public decimal GetTotal()
+    {
+        return Items.Sum(item => item.Price * item.Quantity);
+    }
+}
+
+public class OrderItem
+{
+    public int Id { get; set; }
+    public string ProductName { get; set; }
+    public decimal Price { get; set; }
+    public int Quantity { get; set; }
+}

samples/Orders/Orders.Domain/OrderService.cs

@@ -0,0 +1,49 @@
+using Microsoft.Extensions.Logging;
+
+namespace Orders.Domain;
+
+public class OrderService
+{
+    private readonly ILogger<Order> _logger;
+
+    public OrderService(ILogger<Order> logger)
+    {
+        _logger = logger;
+    }
+
+    public int Id { get; set; }
+    public DateTime OrderDate { get; set; }
+    public string CustomerName { get; set; }
+    public List<OrderItem> Items { get; set; } = new List<OrderItem>();
+
+    public static Order CreateOrder(ILogger<Order> logger, string customerName, List<OrderItem> items)
+    {
+        var order = new Order()
+        {
+            CustomerName = customerName,
+            OrderDate = DateTime.UtcNow,
+            Items = items
+        };
+        logger.LogInformation("Order created for customer: {CustomerName}", customerName);
+        return order;
+    }
+
+    public void AddOrderItem(OrderItem item)
+    {
+        Items.Add(item);
+        _logger.LogInformation("Order item added: {ProductName}", item.ProductName);
+    }
+
+    public decimal GetTotal()
+    {
+        return Items.Sum(item => item.Price * item.Quantity);
+    }
+}
+
+
+public interface IOrderRepository
+{
+    Task<Order> GetOrderByIdAsync(int id);
+    Task AddOrderAsync(Order order);
+    Task SaveChangesAsync();
+}

samples/Orders/Orders.Domain/Orders.Domain.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="7.0.0" />
+  </ItemGroup>
+
+</Project>

samples/Orders/Orders.sln.sln

@@ -0,0 +1,28 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.0.31903.59
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Orders.Api", "Orders.Api\Orders.Api.csproj", "{7325FF68-A2DA-4F26-BFA6-260B98F11374}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Orders.Domain", "Orders.Domain\Orders.Domain.csproj", "{CEB33049-A20A-434C-AC8C-2904E67C85A8}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{7325FF68-A2DA-4F26-BFA6-260B98F11374}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7325FF68-A2DA-4F26-BFA6-260B98F11374}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7325FF68-A2DA-4F26-BFA6-260B98F11374}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7325FF68-A2DA-4F26-BFA6-260B98F11374}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CEB33049-A20A-434C-AC8C-2904E67C85A8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CEB33049-A20A-434C-AC8C-2904E67C85A8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CEB33049-A20A-434C-AC8C-2904E67C85A8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CEB33049-A20A-434C-AC8C-2904E67C85A8}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal

samples/Orders/README.md

@@ -0,0 +1,31 @@
+# Generated with Edits
+
+## Prompt 1
+
+```markdown
+# Ordering Domain
+
+## Context
+- The Ordering Domain uses DDD and Clean Architecture in an ecommerce web api.
+- Business logic is encapsulated for things like `AddOrder`
+
+## Goal
+- generate the entities and aggregates for the Order Domain
+- use Entity Framework
+- use Logging
+```
+
+## Prompt 2
+
+```markdown
+# Ordering API
+
+## Context
+- The Ordering Domain uses DDD and Clean Architecture in an ecommerce web api.
+- We follow REST standards and use OpenAPI spec
+
+## Goal
+- generate the REST methods for Order domain
+- use Controllers, not minimal API
+- use Open Telemetry
+```