feat: add slug based retrieval

Author: syradar

.idea/.idea.KroppensHyllning/.idea/indexLayout.xml

@@ -10,7 +10,7 @@ public static class Campaigns
 
         public const string Create = Base;
 
-        public const string Get = $"{Base}/{{id:guid}}";
+        public const string Get = $"{Base}/{{idOrSlug}}";
 
         public const string GetAll = Base;
 

KroppensHyllning.API/ApiEndpoints.cs

@@ -23,16 +23,18 @@ public async Task<IActionResult> Create([FromBody] CreateCampaignRequest request
         await _campaignRepository.CreateAsync(campaign);
         return CreatedAtAction(
             nameof(Get),
-            new {id = campaign.Id},
+            new {idOrSlug = campaign.Id},
             campaign.MapToResponse()
         );
     }
 
     [HttpGet]
     [Route(ApiEndpoints.Campaigns.Get)]
-    public async Task<IActionResult> Get([FromRoute] Guid id)
+    public async Task<IActionResult> Get([FromRoute] string idOrSlug)
     {
-        var campaign = await _campaignRepository.GetByIdAsync(id);
+        var campaign = Guid.TryParse(idOrSlug, out var id)
+            ? await _campaignRepository.GetByIdAsync(id)
+            : await _campaignRepository.GetBySlugAsync(idOrSlug);
         if (campaign is null) return NotFound();
         var response = campaign.MapToResponse();
         return Ok(response);

KroppensHyllning.API/Controllers/CampaignsController.cs

@@ -35,6 +35,7 @@ public static CampaignResponse MapToResponse(this Campaign campaign)
             Id = campaign.Id,
             Name = campaign.Name,
             StartYear = campaign.StartYear,
+            Slug = campaign.Slug,
             Tags = campaign.Tags
         };
     }

KroppensHyllning.API/Mapping/ContractMapping.cs

@@ -0,0 +1,3 @@
+// Global using directives
+
+global using System.Text.RegularExpressions;

KroppensHyllning.Application/GlobalUsings.cs

@@ -1,11 +1,24 @@
 namespace KroppensHyllning.Application.Models;
 
-public class Campaign
+public partial class Campaign
 {
     public required Guid Id { get; init; }
     public required string Name { get; init; }
+    public string Slug => GenerateSlug();
 
     public required int StartYear { get; init; }
 
     public required List<string> Tags { get; init; } = new();
+
+    private string GenerateSlug()
+    {
+        var replaced = SlugRegex()
+            .Replace(Name, "-")
+            .ToLowerInvariant();
+
+        return $"{replaced}-{StartYear}";
+    }
+
+    [GeneratedRegex("[^a-zA-Z0-9]", RegexOptions.NonBacktracking, 5)]
+    private static partial Regex SlugRegex();
 }

KroppensHyllning.Application/Models/Campaign.cs

@@ -19,6 +19,12 @@ public Task<bool> CreateAsync(Campaign campaign)
         return Task.FromResult(campaign);
     }
 
+    public Task<Campaign?> GetBySlugAsync(string slug)
+    {
+        var campaign = _campaigns.FirstOrDefault(c => c.Slug == slug);
+        return Task.FromResult(campaign);
+    }
+
     public Task<IEnumerable<Campaign>> GetAllAsync()
     {
         return Task.FromResult(_campaigns.AsEnumerable());

KroppensHyllning.Application/Repositories/CampaignRepository.cs

@@ -7,6 +7,7 @@ public interface ICampaignRepository
     Task<bool> CreateAsync(Campaign campaign);
 
     Task<Campaign?> GetByIdAsync(Guid id);
+    Task<Campaign?> GetBySlugAsync(string slug);
 
     Task<IEnumerable<Campaign>> GetAllAsync();
 

KroppensHyllning.Application/Repositories/ICampaignRepository.cs

@@ -5,6 +5,8 @@ public class CampaignResponse
     public required Guid Id { get; init; }
     public required string Name { get; init; }
 
+    public required string Slug { get; init; }
+
     public required int StartYear { get; init; }
 
     public required IEnumerable<string> Tags { get; init; } = Enumerable.Empty<string>();

KroppensHyllning.Contracts/Responses/CampaignResponse.cs

@@ -2,12 +2,13 @@
 
 _The Body's Celebration_ is in stark contrast to Yxans Klagan _The Axe's Lamentations_.
 
-This is a Restful API built in .Net Core for managing a Forbidden Lands RPG campaign, this would be used by https://github.com/syradar/yxans-klagan to render the UI.
+This is a Restful API built in .Net Core for managing a Forbidden Lands RPG campaign, this would be used
+by https://github.com/syradar/yxans-klagan to render the UI.
 
 ## Features
 
 - [X] Manage Campaigns, CRUD
-- [ ] Slug based URLs
+- [X] Slug based URLs
 - [ ] Versioning
 - [ ] Authentication
 - [ ] Authorization