Update sample's Projects endpoints to follow conventions

Author: ardalis

sample/src/NimblePros.SampleToDo.UseCases/Projects/Create/CreateProjectCommand.cs

@@ -6,4 +6,4 @@ namespace NimblePros.SampleToDo.UseCases.Projects.Create;
 /// Create a new Project.
 /// </summary>
 /// <param name="Name"></param>
-public record CreateProjectCommand(string Name) : ICommand<Result<ProjectId>>;
+public record CreateProjectCommand(ProjectName Name) : ICommand<Result<ProjectId>>;

sample/src/NimblePros.SampleToDo.UseCases/Projects/Create/CreateProjectHandler.cs

@@ -9,7 +9,7 @@ public class CreateProjectHandler(IRepository<Project> repository) : ICommandHan
   public async ValueTask<Result<ProjectId>> Handle(CreateProjectCommand request,
     CancellationToken cancellationToken)
   {
-    var newProject = new Project(ProjectName.From(request.Name));
+    var newProject = new Project(request.Name);
     // NOTE: This implementation issues 3 queries due to Vogen implementation
     var createdItem = await _repository.AddAsync(newProject, cancellationToken);
 

sample/src/NimblePros.SampleToDo.Web/Projects/Create.CreateProjectRequest.cs

@@ -7,5 +7,5 @@ public class CreateProjectRequest
   public const string Route = "/Projects";
 
   [Required]
-  public string? Name { get; set; }
+  public string Name { get; set; } = String.Empty;
 }

sample/src/NimblePros.SampleToDo.Web/Projects/Create.CreateProjectResponse.cs

@@ -1,13 +1,3 @@
 namespace NimblePros.SampleToDo.Web.Projects;
 
-public class CreateProjectResponse
-{
-  public CreateProjectResponse(int id, string name)
-  {
-    Id = id;
-    Name = name;
-  }
-
-  public int Id { get; set; }
-  public string Name { get; set; }
-}
+public record CreateProjectResponse(int Id, string Name);

sample/src/NimblePros.SampleToDo.Web/Projects/Create.CreateProjectValidator.cs

@@ -1,12 +1,9 @@
 using FastEndpoints;
 using FluentValidation;
-using NimblePros.SampleToDo.Infrastructure.Data.Config;
+using NimblePros.SampleToDo.Core.ProjectAggregate;
 
 namespace NimblePros.SampleToDo.Web.Projects;
 
-/// <summary>
-/// See: https://fast-endpoints.com/docs/validation
-/// </summary>
 public class CreateProjectValidator : Validator<CreateProjectRequest>
 {
   public CreateProjectValidator()
@@ -15,6 +12,6 @@ public CreateProjectValidator()
       .NotEmpty()
       .WithMessage("Name is required.")
       .MinimumLength(2)
-      .MaximumLength(DataSchemaConstants.DEFAULT_NAME_LENGTH);
+      .MaximumLength(ProjectName.MaxLength);
   }
 }

sample/src/NimblePros.SampleToDo.Web/Projects/Create.cs

@@ -1,15 +1,11 @@
-using Ardalis.Result.AspNetCore;
+using NimblePros.SampleToDo.Core.ProjectAggregate;
 using NimblePros.SampleToDo.UseCases.Projects.Create;
+using NimblePros.SampleToDo.Web.Extensions;
 
 namespace NimblePros.SampleToDo.Web.Projects;
 
-/// <summary>
-/// Creates a new Project
-/// </summary>
-/// <remarks>
-/// Creates a new project given a name.
-/// </remarks>
-public class Create(IMediator mediator) : Endpoint<CreateProjectRequest, CreateProjectResponse>
+public class Create(IMediator mediator) 
+  : Endpoint<CreateProjectRequest, Results<Created<CreateProjectResponse>, ValidationProblem, ProblemHttpResult>>
 {
   private readonly IMediator _mediator = mediator;
 
@@ -19,21 +15,35 @@ public override void Configure()
     AllowAnonymous();
     Summary(s =>
     {
-      s.ExampleRequest = new CreateProjectRequest { Name = "Project Name" };
+      s.Summary = "Create a new project";
+      s.Description = "Creates a new project with the provided name. The project name must be between 2 and 100 characters long.";
+      s.ExampleRequest = new CreateProjectRequest { Name = "My New Project" };
+      s.ResponseExamples[201] = new CreateProjectResponse(1, "My New Project");
+      
+      // Document possible responses
+      s.Responses[201] = "Project created successfully";
+      s.Responses[400] = "Invalid input data - validation errors";
+      s.Responses[500] = "Internal server error";
     });
+    
+    // Add tags for API grouping
+    Tags("Projects");
+    
+    // Add additional metadata
+    Description(builder => builder
+      .Accepts<CreateProjectRequest>("application/json")
+      .Produces<CreateProjectResponse>(201, "application/json")
+      .ProducesProblem(400)
+      .ProducesProblem(500));
   }
 
-  public override async Task HandleAsync(
-  CreateProjectRequest request,
-  CancellationToken cancellationToken)
+  public override async Task<Results<Created<CreateProjectResponse>, ValidationProblem, ProblemHttpResult>>
+    ExecuteAsync(CreateProjectRequest request, CancellationToken cancellationToken)
   {
-    var result = await _mediator.Send(new CreateProjectCommand(request.Name!));
+    var result = await _mediator.Send(new CreateProjectCommand(ProjectName.From(request.Name!)));
 
-    if (result.IsSuccess)
-    {
-      Response = new CreateProjectResponse(result.Value.Value, request.Name!);
-      return;
-    }
-    await Send.ResultAsync(result.ToMinimalApiResult());
+    return result.ToCreatedResult(
+      id => $"/Projects/{id}", 
+      id => new CreateProjectResponse(id.Value, request.Name!));
   }
 }

sample/src/NimblePros.SampleToDo.Web/Projects/CreateToDoItem.cs

@@ -1,11 +1,12 @@
 using NimblePros.SampleToDo.Core.ContributorAggregate;
 using NimblePros.SampleToDo.Core.ProjectAggregate;
 using NimblePros.SampleToDo.UseCases.Projects.AddToDoItem;
+using NimblePros.SampleToDo.Web.Extensions;
 using NimblePros.SampleToDo.Web.Projects;
 
 namespace NimblePros.SampleToDo.Web.ProjectEndpoints;
 
-public class Create : Endpoint<CreateToDoItemRequest>
+public class Create : Endpoint<CreateToDoItemRequest, Results<Created, NotFound, ProblemHttpResult>>
 {
   private readonly IMediator _mediator;
 
@@ -20,19 +21,37 @@ public override void Configure()
     AllowAnonymous();
     Summary(s =>
     {
+      s.Summary = "Add a new todo item to a project";
+      s.Description = "Creates a new todo item within an existing project. The project must exist and the contributor (if specified) must be valid.";
       s.ExampleRequest = new CreateToDoItemRequest
       {
         ContributorId = 1,
         ProjectId = 1,
-        Title = "Title",
-        Description = "Description"
+        Title = "Implement user authentication",
+        Description = "Add JWT-based authentication to the API"
       };
+      
+      // Document possible responses
+      s.Responses[201] = "Todo item created successfully";
+      s.Responses[404] = "Project or contributor not found";
+      s.Responses[400] = "Invalid input data";
+      s.Responses[500] = "Internal server error";
     });
+    
+    // Add tags for API grouping
+    Tags("Projects");
+    
+    // Add additional metadata
+    Description(builder => builder
+      .Accepts<CreateToDoItemRequest>("application/json")
+      .Produces(201)
+      .ProducesProblem(404)
+      .ProducesProblem(400)
+      .ProducesProblem(500));
   }
 
-  public override async Task HandleAsync(
-    CreateToDoItemRequest request,
-    CancellationToken cancellationToken)
+  public override async Task<Results<Created, NotFound, ProblemHttpResult>>
+    ExecuteAsync(CreateToDoItemRequest request, CancellationToken cancellationToken)
   {
     ContributorId? contributorId = request.ContributorId.HasValue
                                     ? ContributorId.From(request.ContributorId.Value)
@@ -41,17 +60,14 @@ public override async Task HandleAsync(
       request.Title, request.Description);
     var result = await _mediator.Send(command);
 
-    if (result.Status == ResultStatus.NotFound)
+    return result.Status switch
     {
-      await Send.NotFoundAsync(cancellationToken);
-      return;
-    }
-
-    if (result.IsSuccess)
-    {
-      // send route to project
-      await Send.CreatedAtAsync<GetById>(new { projectId = request.ProjectId }, "");
+      ResultStatus.Ok => TypedResults.Created($"/Projects/{request.ProjectId}"),
+      ResultStatus.NotFound => TypedResults.NotFound(),
+      _ => TypedResults.Problem(
+        title: "Create todo item failed",
+        detail: string.Join("; ", result.Errors),
+        statusCode: StatusCodes.Status400BadRequest)
     };
-    // TODO: Handle other cases as necessary
   }
 }

sample/src/NimblePros.SampleToDo.Web/Projects/Delete.DeleteProjectValidator.cs

@@ -0,0 +1,16 @@
+using FastEndpoints;
+using FluentValidation;
+
+namespace NimblePros.SampleToDo.Web.Projects;
+
+/// <summary>
+/// See: https://fast-endpoints.com/docs/validation
+/// </summary>
+public class DeleteProjectValidator : Validator<DeleteProjectRequest>
+{
+  public DeleteProjectValidator()
+  {
+    RuleFor(x => x.ProjectId)
+      .GreaterThan(0);
+  }
+}

sample/src/NimblePros.SampleToDo.Web/Projects/Delete.cs

@@ -1,30 +1,51 @@
-using Ardalis.Result.AspNetCore;
-using NimblePros.SampleToDo.Core.ProjectAggregate;
+using NimblePros.SampleToDo.Core.ProjectAggregate;
 using NimblePros.SampleToDo.UseCases.Projects.Delete;
+using NimblePros.SampleToDo.Web.Extensions;
 
 namespace NimblePros.SampleToDo.Web.Projects;
 
-/// <summary>
-/// Deletes a project
-/// </summary>
-public class Delete(IMediator mediator) : Endpoint<DeleteProjectRequest>
+public class Delete
+  : Endpoint<DeleteProjectRequest,
+             Results<NoContent,
+                     NotFound,
+                     ProblemHttpResult>>
 {
-  private readonly IMediator _mediator = mediator;
+  private readonly IMediator _mediator;
+  public Delete(IMediator mediator) => _mediator = mediator;
 
   public override void Configure()
   {
     Delete(DeleteProjectRequest.Route);
     AllowAnonymous();
+    Summary(s =>
+    {
+      s.Summary = "Delete a project";
+      s.Description = "Deletes an existing project by ID. This will also delete all associated todo items. This action cannot be undone.";
+      s.ExampleRequest = new DeleteProjectRequest { ProjectId = 1 };
+      
+      // Document possible responses
+      s.Responses[204] = "Project deleted successfully";
+      s.Responses[404] = "Project not found";
+      s.Responses[400] = "Invalid request or deletion failed";
+    });
+    
+    // Add tags for API grouping
+    Tags("Projects");
+    
+    // Add additional metadata
+    Description(builder => builder
+      .Accepts<DeleteProjectRequest>()
+      .Produces(204)
+      .ProducesProblem(404)
+      .ProducesProblem(400));
   }
 
-  public override async Task HandleAsync(
-  DeleteProjectRequest request,
-  CancellationToken cancellationToken)
+  public override async Task<Results<NoContent, NotFound, ProblemHttpResult>>
+    ExecuteAsync(DeleteProjectRequest req, CancellationToken ct)
   {
-    var command = new DeleteProjectCommand(ProjectId.From(request.ProjectId));
+    var cmd = new DeleteProjectCommand(ProjectId.From(req.ProjectId));
+    var result = await _mediator.Send(cmd, ct);
 
-    var result = await _mediator.Send(command);
-
-    await Send.ResultAsync(result.ToMinimalApiResult());
+    return result.ToDeleteResult();
   }
 }

sample/src/NimblePros.SampleToDo.Web/Projects/GetById.GetProjectByIdResponse.cs

@@ -1,15 +1,3 @@
 namespace NimblePros.SampleToDo.Web.Projects;
 
-public class GetProjectByIdResponse
-{
-  public GetProjectByIdResponse(int id, string name, List<ToDoItemRecord> items)
-  {
-    Id = id;
-    Name = name;
-    Items = items;
-  }
-
-  public int Id { get; set; }
-  public string Name { get; set; }
-  public List<ToDoItemRecord> Items { get; set; } = new();
-}
+public record GetProjectByIdResponse(int Id, string Name, List<ToDoItemRecord> Items);