Setup swagger

GuildWarsPartySearch.Common/Models/GuildWars/Campaign.cs

@@ -100,7 +100,7 @@ public static bool TryParse(int id, out Campaign campaign)
     }
     public static bool TryParse(string name, out Campaign campaign)
     {
-        campaign = Campaigns.Where(region => region.Name == name).FirstOrDefault()!;
+        campaign = Campaigns.Where(region => region.Name?.Equals(name, StringComparison.OrdinalIgnoreCase) is true).FirstOrDefault()!;
         if (campaign is null)
         {
             return false;

GuildWarsPartySearch.Common/Models/GuildWars/Continent.cs

@@ -116,7 +116,7 @@ public static bool TryParse(int id, out Continent continent)
     }
     public static bool TryParse(string name, out Continent continent)
     {
-        continent = Continents.Where(continent => continent.Name == name).FirstOrDefault()!;
+        continent = Continents.Where(continent => continent.Name?.Equals(name, StringComparison.OrdinalIgnoreCase) is true).FirstOrDefault()!;
         if (continent is null)
         {
             return false;

GuildWarsPartySearch.Common/Models/GuildWars/Map.cs

@@ -1427,7 +1427,7 @@ public static bool TryParse(int id, out Map map)
     }
     public static bool TryParse(string name, out Map map)
     {
-        map = Maps.Where(map => map.Name == name).FirstOrDefault()!;
+        map = Maps.Where(map => map.Name?.Equals(name, StringComparison.OrdinalIgnoreCase) is true).FirstOrDefault()!;
         if (map is null)
         {
             return false;

GuildWarsPartySearch.Common/Models/GuildWars/Region.cs

@@ -860,7 +860,7 @@ public static bool TryParse(int id, out Region region)
     }
     public static bool TryParse(string name, out Region region)
     {
-        region = Regions.Where(region => region.Name == name).FirstOrDefault()!;
+        region = Regions.Where(region => region.Name?.Equals(name, StringComparison.OrdinalIgnoreCase) is true).FirstOrDefault()!;
         if (region is null)
         {
             return false;

GuildWarsPartySearch/Endpoints/PartySearchController.cs

@@ -0,0 +1,93 @@
+using GuildWarsPartySearch.Server.Models.Endpoints;
+using GuildWarsPartySearch.Server.Services.PartySearch;
+using Microsoft.AspNetCore.Mvc;
+using System.Core.Extensions;
+
+namespace GuildWarsPartySearch.Server.Endpoints;
+
+[Route("party-search")]
+public sealed class PartySearchController : Controller
+{
+    private readonly IPartySearchService partySearchService;
+
+    public PartySearchController(
+        IPartySearchService partySearchService)
+    {
+        this.partySearchService = partySearchService.ThrowIfNull();
+    }
+
+    [HttpGet("characters/{charName}")]
+    [ProducesResponseType(200)]
+    [ProducesResponseType(400)]
+    public async Task<IActionResult> GetByCharName(string charName)
+    {
+        var result = await this.partySearchService.GetPartySearchesByCharName(charName, this.HttpContext.RequestAborted);
+        return result.Switch<IActionResult>(
+            onSuccess: list => this.Ok(list),
+            onFailure: failure => failure switch
+            {
+                GetPartySearchFailure.InvalidCharName => this.BadRequest("Invalid char name"),
+                _ => this.Problem()
+            });
+    }
+
+    [HttpGet("campaigns/{campaign}")]
+    [ProducesResponseType(200)]
+    [ProducesResponseType(400)]
+    public async Task<IActionResult> GetByCampaign(string campaign)
+    {
+        var result = await this.partySearchService.GetPartySearchesByCampaign(campaign, this.HttpContext.RequestAborted);
+        return result.Switch<IActionResult>(
+            onSuccess: list => this.Ok(list),
+            onFailure: failure => failure switch
+            {
+                GetPartySearchFailure.InvalidCampaign => this.BadRequest("Invalid campaign"),
+                _ => this.Problem()
+            });
+    }
+
+    [HttpGet("continents/{continent}")]
+    [ProducesResponseType(200)]
+    [ProducesResponseType(400)]
+    public async Task<IActionResult> GetByContinent(string continent)
+    {
+        var result = await this.partySearchService.GetPartySearchesByContinent(continent, this.HttpContext.RequestAborted);
+        return result.Switch<IActionResult>(
+            onSuccess: list => this.Ok(list),
+            onFailure: failure => failure switch
+            {
+                GetPartySearchFailure.InvalidContinent => this.BadRequest("Invalid continent"),
+                _ => this.Problem()
+            });
+    }
+
+    [HttpGet("regions/{region}")]
+    [ProducesResponseType(200)]
+    [ProducesResponseType(400)]
+    public async Task<IActionResult> GetByRegion(string region)
+    {
+        var result = await this.partySearchService.GetPartySearchesByRegion(region, this.HttpContext.RequestAborted);
+        return result.Switch<IActionResult>(
+            onSuccess: list => this.Ok(list),
+            onFailure: failure => failure switch
+            {
+                GetPartySearchFailure.InvalidRegion => this.BadRequest("Invalid region"),
+                _ => this.Problem()
+            });
+    }
+
+    [HttpGet("maps/{map}")]
+    [ProducesResponseType(200)]
+    [ProducesResponseType(400)]
+    public async Task<IActionResult> GetByMap(string map)
+    {
+        var result = await this.partySearchService.GetPartySearchesByMap(map, this.HttpContext.RequestAborted);
+        return result.Switch<IActionResult>(
+            onSuccess: list => this.Ok(list),
+            onFailure: failure => failure switch
+            {
+                GetPartySearchFailure.InvalidMap => this.BadRequest("Invalid map"),
+                _ => this.Problem()
+            });
+    }
+}

GuildWarsPartySearch/Filters/ApiKeyProtected.cs

@@ -7,7 +7,7 @@ namespace GuildWarsPartySearch.Server.Filters;
 
 public sealed class ApiKeyProtected : IActionFilter
 {
-    private const string ApiKeyHeader = "X-ApiKey";
+    public const string ApiKeyHeader = "X-ApiKey";
 
     public void OnActionExecuting(ActionExecutingContext context)
     {

GuildWarsPartySearch/GuildWarsPartySearch.Server.csproj

@@ -12,6 +12,8 @@
     <PackageReference Include="AspNetCoreRateLimit" Version="5.0.0" />
     <PackageReference Include="Azure.Data.Tables" Version="12.8.2" />
     <PackageReference Include="Azure.Storage.Blobs" Version="12.19.1" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Swagger" Version="6.5.0" />
     <PackageReference Include="System.Net.Http" Version="4.3.4" />
     <PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
     <PackageReference Include="SystemExtensions.NetCore" Version="1.0.1" />

GuildWarsPartySearch/Launch/Program.cs

@@ -2,7 +2,7 @@
 using AspNetCoreRateLimit;
 using GuildWarsPartySearch.Server.Options;
 using Microsoft.Extensions.FileProviders;
-using Microsoft.Extensions.Options;
+using Microsoft.OpenApi.Models;
 using System.Net;
 using System.Security.Cryptography.X509Certificates;
 using System.Text.Json;
@@ -26,6 +26,11 @@ private static async Task Main()
         var builder = WebApplication.CreateBuilder()
             .SetupOptions()
             .SetupHostedServices();
+        builder.Services.AddSwaggerGen(c =>
+        {
+            c.SwaggerDoc("v1", new OpenApiInfo { Title = "Guild Wars Party Search API", Version = "v1" });
+            c.DocumentFilter<WebSocketEndpointsDocumentFilter>();
+        });
         builder.Services.AddSingleton(jsonOptions);
         builder.Logging.SetupLogging();
         builder.Services.SetupServices();
@@ -54,13 +59,15 @@ private static async Task Main()
         }
 
         var app = builder.Build();
-        app.UseIpRateLimiting()
+        app.UseSwagger()
+           .UseIpRateLimiting()
            .UseWebSockets()
            .UseRouting()
            .UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            })
+           .UseSwaggerUI(c => c.SwaggerEndpoint("v1/swagger.json", "Guild Wars Party Search API"))
            .UseStaticFiles(new StaticFileOptions
            {
                FileProvider = new PhysicalFileProvider(contentDirectory.FullName)

GuildWarsPartySearch/Launch/WebSocketEndpointsDocumentFilter.cs

@@ -0,0 +1,124 @@
+using GuildWarsPartySearch.Server.Filters;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace GuildWarsPartySearch.Server.Launch;
+
+public sealed class WebSocketEndpointsDocumentFilter : IDocumentFilter
+{
+    public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
+    {
+        swaggerDoc.Paths.Add("/party-search/live-feed",
+            new OpenApiPathItem
+            { 
+                Summary = "Connect to WebSocket for live feed",
+                Description = "WebSocket endpoint for live feed.",
+                Operations = new Dictionary<OperationType, OpenApiOperation>
+                {
+                    { 
+                        OperationType.Get,
+                        new OpenApiOperation()
+                        { 
+                            Tags = new List<OpenApiTag>
+                            { 
+                                new() 
+                                { 
+                                    Name = "PartySearch" 
+                                } 
+                            }, 
+                            Description = "WebSocket endpoint for live feed.",
+                            Responses = new OpenApiResponses
+                            {
+                                { "200", new OpenApiResponse(){ Description = "Success" } },
+                            }
+                        }
+                    }
+                },
+                Parameters = new List<OpenApiParameter>
+                {
+                    new()
+                    {
+                        Name = "Connection",
+                        In = ParameterLocation.Header,
+                        Description = "WebSocket upgrade header",
+                        Required = true,
+
+                    },
+                    new()
+                    {
+                        Name = "Sec-WebSocket-Version",
+                        In = ParameterLocation.Header,
+                        Description = "WebSocket protocol version",
+                        Required = true
+                    },
+                    new()
+                    {
+                        Name = "Sec-WebSocket-Key",
+                        In = ParameterLocation.Header,
+                        Description = "WebSocket key",
+                        Required = true
+                    },
+                }
+            });
+        swaggerDoc.Paths.Add("/party-search/update",
+            new OpenApiPathItem
+            {
+                Summary = "Connect to WebSocket for updates",
+                Description = $"WebSocket endpoint for posting party search updates. Protected by {ApiKeyProtected.ApiKeyHeader} header.",
+                Operations = new Dictionary<OperationType, OpenApiOperation>
+                {
+                    {
+                        OperationType.Get,
+                        new OpenApiOperation()
+                        { 
+                            Tags = new List<OpenApiTag>
+                            { 
+                                new()
+                                { 
+                                    Name = "PartySearch" 
+                                } 
+                            }, 
+                            Description = $"WebSocket endpoint for posting party search updates. Protected by {ApiKeyProtected.ApiKeyHeader} header.",
+                            Responses = new OpenApiResponses
+                            {
+                                { "200", new OpenApiResponse(){ Description = "Success" } },
+                                { "403", new OpenApiResponse(){ Description = "Forbidden" } }
+                            }
+                        }
+                    }
+                },
+                Parameters = new List<OpenApiParameter>
+                {
+                    new()
+                    {
+                        Name = ApiKeyProtected.ApiKeyHeader,
+                        In = ParameterLocation.Header,
+                        Description = "Header is required in order to connect to this endpoint",
+                        Required = true
+                    },
+                    new()
+                    {
+                        Name = "Connection",
+                        In = ParameterLocation.Header,
+                        Description = "WebSocket upgrade header",
+                        Required = true,
+
+                    },
+                    new()
+                    {
+                        Name = "Sec-WebSocket-Version",
+                        In = ParameterLocation.Header,
+                        Description = "WebSocket protocol version",
+                        Required = true
+                    },
+                    new()
+                    {
+                        Name = "Sec-WebSocket-Key",
+                        In = ParameterLocation.Header,
+                        Description = "WebSocket key",
+                        Required = true
+                    },
+                },
+            });
+    }
+}

GuildWarsPartySearch/Services/Database/IPartySearchDatabase.cs

@@ -5,6 +5,10 @@ namespace GuildWarsPartySearch.Server.Services.Database;
 
 public interface IPartySearchDatabase
 {
+    Task<List<Server.Models.PartySearch>> GetPartySearchesByCampaign(Campaign campaign, CancellationToken cancellationToken);
+    Task<List<Server.Models.PartySearch>> GetPartySearchesByContinent(Continent continent, CancellationToken cancellationToken);
+    Task<List<Server.Models.PartySearch>> GetPartySearchesByRegion(Region region, CancellationToken cancellationToken);
+    Task<List<Server.Models.PartySearch>> GetPartySearchesByMap(Map map, CancellationToken cancellationToken);
     Task<List<Server.Models.PartySearch>> GetPartySearchesByCharName(string charName, CancellationToken cancellationToken);
     Task<List<Server.Models.PartySearch>> GetAllPartySearches(CancellationToken cancellationToken);
     Task<bool> SetPartySearches(Campaign campaign, Continent continent, Region region, Map map, string district, List<PartySearchEntry> partySearch, CancellationToken cancellationToken);