WebApi Changes

src/ServerManager.WebApplication/Controllers/HealthController.cs

@@ -1,27 +0,0 @@
-using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.Mvc;
-
-namespace ServerManager.WebApplication.Controllers;
-
-[Route("api/[controller]")]
-[ApiController]
-[ApiVersion("1.0")]
-[Produces("application/json")]
-public class HealthController : ControllerBase
-{
-    [HttpGet()]
-    [ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
-    [ProducesResponseType(StatusCodes.Status200OK)]
-    [ProducesResponseType(StatusCodes.Status500InternalServerError)]
-    public IActionResult Get()
-    {
-        try
-        {
-            return Ok();
-        }
-        catch
-        {
-            return StatusCode(StatusCodes.Status500InternalServerError);
-        }
-    }
-}

src/ServerManager.WebApplication/Controllers/ServerController.cs

@@ -1,12 +1,10 @@
-using Microsoft.AspNetCore.Http;
+using System;
+using System.Collections.Generic;
+using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
-using Microsoft.Extensions.Configuration;
-using Microsoft.Extensions.Logging;
 using ServerManager.WebApplication.Models;
 using ServerManager.WebApplication.Models.ApiVersion1;
 using ServerManager.WebApplication.Services;
-using System;
-using System.Collections.Generic;
 
 namespace ServerManager.WebApplication.Controllers;
 

src/ServerManager.WebApplication/Extensions/ServerQueryExtensions.cs

@@ -0,0 +1,18 @@
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using ServerManager.WebApplication.Models.Data;
+using ServerManager.WebApplication.Services;
+
+namespace ServerManager.WebApplication.Extensions;
+
+public static class ServerQueryExtensions
+{
+    public static IServiceCollection AddServerQueryServices(this IServiceCollection services, IConfiguration configuration)
+    {
+        var settings = configuration.GetSectionAs<ServerQuerySettings>();
+        services.AddSingleton(settings);
+        
+        services.AddScoped<IServerQueryService, QueryMasterService>();
+        return services;
+    }
+}

src/ServerManager.WebApplication/Extensions/ServiceCollectionExtensions.cs

@@ -0,0 +1,14 @@
+using Microsoft.Extensions.Configuration;
+
+namespace ServerManager.WebApplication.Extensions;
+
+public static class ServiceCollectionExtensions
+{
+    public static T GetSectionAs<T>(this IConfiguration configuration, string sectionName = null)
+    {
+        if (string.IsNullOrWhiteSpace(sectionName))
+            sectionName = typeof(T).Name;
+
+        return configuration.GetSection(sectionName).Get<T>();
+    }
+}

src/ServerManager.WebApplication/Extensions/SwaggerDefaultValues.cs

@@ -1,56 +0,0 @@
-using Microsoft.AspNetCore.Mvc.ApiExplorer;
-using Microsoft.OpenApi.Models;
-using Swashbuckle.AspNetCore.SwaggerGen;
-using System.Linq;
-using System.Text.Json;
-
-namespace ServerManager.WebApplication.Extensions
-{
-    public class SwaggerDefaultValues : IOperationFilter
-    {
-        public void Apply(OpenApiOperation operation, OperationFilterContext context)
-        {
-            var apiDescription = context.ApiDescription;
-
-            operation.Deprecated |= apiDescription.IsDeprecated();
-
-            foreach (var responseType in context.ApiDescription.SupportedResponseTypes)
-            {
-                var responseKey = responseType.IsDefaultResponse ? "default" : responseType.StatusCode.ToString();
-                var response = operation.Responses[responseKey];
-
-                foreach (var contentType in response.Content.Keys)
-                {
-                    if (!responseType.ApiResponseFormats.Any(x => x.MediaType == contentType))
-                    {
-                        response.Content.Remove(contentType);
-                    }
-                }
-            }
-
-            if (operation.Parameters is null)
-            {
-                return;
-            }
-
-            foreach (var parameter in operation.Parameters)
-            {
-                var description = apiDescription.ParameterDescriptions
-                                                .First(p => p.Name == parameter.Name);
-
-                if (parameter.Description is null)
-                {
-                    parameter.Description = description.ModelMetadata?.Description;
-                }
-
-                if (parameter.Schema.Default is null && description.DefaultValue is not null)
-                {
-                    var json = JsonSerializer.Serialize(description.DefaultValue, description.ModelMetadata.ModelType);
-                    parameter.Schema.Default = OpenApiAnyFactory.CreateFromJson(json);
-                }
-
-                parameter.Required |= description.IsRequired;
-            }
-        }
-    }
-}

src/ServerManager.WebApplication/Middleware/SwaggerDefaultValues.cs

@@ -0,0 +1,55 @@
+using System.Linq;
+using System.Text.Json;
+using Microsoft.AspNetCore.Mvc.ApiExplorer;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace ServerManager.WebApplication.Middleware;
+
+public class SwaggerDefaultValues : IOperationFilter
+{
+    public void Apply(OpenApiOperation operation, OperationFilterContext context)
+    {
+        var apiDescription = context.ApiDescription;
+
+        operation.Deprecated |= apiDescription.IsDeprecated();
+
+        foreach (var responseType in context.ApiDescription.SupportedResponseTypes)
+        {
+            var responseKey = responseType.IsDefaultResponse ? "default" : responseType.StatusCode.ToString();
+            var response = operation.Responses[responseKey];
+
+            foreach (var contentType in response.Content.Keys)
+            {
+                if (!responseType.ApiResponseFormats.Any(x => x.MediaType == contentType))
+                {
+                    response.Content.Remove(contentType);
+                }
+            }
+        }
+
+        if (operation.Parameters is null)
+        {
+            return;
+        }
+
+        foreach (var parameter in operation.Parameters)
+        {
+            var description = apiDescription.ParameterDescriptions
+                                            .First(p => p.Name == parameter.Name);
+
+            if (parameter.Description is null)
+            {
+                parameter.Description = description.ModelMetadata?.Description;
+            }
+
+            if (parameter.Schema.Default is null && description.DefaultValue is not null)
+            {
+                var json = JsonSerializer.Serialize(description.DefaultValue, description.ModelMetadata.ModelType);
+                parameter.Schema.Default = OpenApiAnyFactory.CreateFromJson(json);
+            }
+
+            parameter.Required |= description.IsRequired;
+        }
+    }
+}

src/ServerManager.WebApplication/Models/ApiVersion1/ErrorResponse.cs

@@ -2,8 +2,8 @@
 using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 
-namespace ServerManager.WebApplication.Models.ApiVersion1
+namespace ServerManager.WebApplication.Models.ApiVersion1;
-{
+
 public class ErrorResponse
 {
     /// <summary>
@@ -13,4 +13,3 @@ namespace ServerManager.WebApplication.Models.ApiVersion1
     [Description("List of errors.")]
     public ICollection<string> Errors { get; set; } = new List<string>();
 }
-}

src/ServerManager.WebApplication/Models/ApiVersion1/ServerStatusResponse.cs

@@ -1,8 +1,8 @@
 using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 
-namespace ServerManager.WebApplication.Models.ApiVersion1
+namespace ServerManager.WebApplication.Models.ApiVersion1;
-{
+
 public class ServerStatusResponse
 {
     /// <summary>
@@ -12,4 +12,3 @@ namespace ServerManager.WebApplication.Models.ApiVersion1
     [Description("True if the server is available; otherwise false.")]
     public string Available { get; set; } = false.ToString();
 }
-}

src/ServerManager.WebApplication/Models/Data/ManagerCode.cs

@@ -1,7 +1,7 @@
 using System.Runtime.Serialization;
 
-namespace ServerManager.WebApplication.Models.Data
+namespace ServerManager.WebApplication.Models.Data;
-{
+
 [DataContract]
 public class ManagerCode
 {
@@ -10,4 +10,3 @@ namespace ServerManager.WebApplication.Models.Data
     [DataMember]
     public string Code { get; set; } = string.Empty;
 }
-}

src/ServerManager.WebApplication/Models/Data/ServerQuerySettings.cs

@@ -0,0 +1,9 @@
+using System.Collections.Generic;
+
+namespace ServerManager.WebApplication.Models.Data
+{
+    public class ServerQuerySettings
+    {
+        public List<ManagerCode> ManagerCodes { get; set; }
+    }
+}

src/ServerManager.WebApplication/Models/ServerManagerApiException.cs

@@ -2,8 +2,8 @@
 using System.Collections.Generic;
 using System.Runtime.Serialization;
 
-namespace ServerManager.WebApplication.Models
+namespace ServerManager.WebApplication.Models;
-{
+
 public class ServerManagerApiException : Exception
 {
     public ServerManagerApiException() : base()
@@ -28,4 +28,3 @@ namespace ServerManager.WebApplication.Models
 
     public ICollection<string> Messages { get; private set; } = new List<string>();
 }
-}

src/ServerManager.WebApplication/Program.cs

@@ -1,8 +1,8 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Hosting;
 
-namespace ServerManager.WebApplication
+namespace ServerManager.WebApplication;
-{
+
 public class Program
 {
     public static void Main(string[] args)
@@ -17,4 +17,3 @@ namespace ServerManager.WebApplication
                 webBuilder.UseStartup<Startup>();
             });
 }
-}

src/ServerManager.WebApplication/Services/IServerQueryService.cs

@@ -1,7 +1,6 @@
-namespace ServerManager.WebApplication.Services
+namespace ServerManager.WebApplication.Services;
-{
+
 public interface IServerQueryService
 {
     bool CheckServerStatus(string managerCode, string managerVersion, string ipString, int port);
 }
-}

src/ServerManager.WebApplication/Services/QueryMasterService.cs

@@ -1,24 +1,21 @@
-using Microsoft.AspNetCore.Http;
+using System;
-using Microsoft.Extensions.Configuration;
-using QueryMaster;
-using ServerManager.WebApplication.Models;
-using ServerManager.WebApplication.Models.Data;
-using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Net;
+using Microsoft.AspNetCore.Http;
+using QueryMaster;
+using ServerManager.WebApplication.Models;
+using ServerManager.WebApplication.Models.Data;
+
+namespace ServerManager.WebApplication.Services;
 
-namespace ServerManager.WebApplication.Services
-{
 public class QueryMasterService : IServerQueryService
 {
-        internal const string CONFIG_MANAGERCODES = "ManagerCodes";
+    private readonly ServerQuerySettings _settings;
 
-        private readonly IConfiguration _configuration;
+    public QueryMasterService(ServerQuerySettings settings)
-
-        public QueryMasterService(IConfiguration configuration)
     {
-            _configuration = configuration;
+        _settings = settings;
     }
 
     public bool CheckServerStatus(string managerCode, string managerVersion, string ipString, int port)
@@ -28,9 +25,7 @@ namespace ServerManager.WebApplication.Services
         try
         {
             using var server = ServerQuery.GetServerInstance(EngineType.Source, ipString, (ushort)port);
-
+            return server.GetInfo() != null;
-                var serverInfo = server.GetInfo();
-                return serverInfo != null;
         }
         catch
         {
@@ -48,7 +43,7 @@ namespace ServerManager.WebApplication.Services
         }
         else
         {
-                var managerCodes = _configuration.GetSection(CONFIG_MANAGERCODES).Get<List<ManagerCode>>() ?? new List<ManagerCode>();
+            var managerCodes = _settings.ManagerCodes ?? new List<ManagerCode>();
             if (!managerCodes.Any(c => c.Code.Equals(managerCode, StringComparison.OrdinalIgnoreCase)))
             {
                 errors.Add("Manager code is invalid.");
@@ -75,4 +70,3 @@ namespace ServerManager.WebApplication.Services
         }
     }
 }
-}

src/ServerManager.WebApplication/Startup.cs

@@ -1,4 +1,5 @@
 using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Diagnostics.HealthChecks;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.ApiExplorer;
@@ -7,10 +8,10 @@ using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using ServerManager.WebApplication.Extensions;
-using ServerManager.WebApplication.Services;
+using ServerManager.WebApplication.Middleware;
+
+namespace ServerManager.WebApplication;
 
-namespace ServerManager.WebApplication
-{
 public class Startup
 {
     public Startup(IConfiguration configuration)
@@ -48,12 +49,14 @@ namespace ServerManager.WebApplication
             o.GroupNameFormat = "'v'VVV";
         });
 
-            services.AddScoped<IServerQueryService, QueryMasterService>();
+        services.AddServerQueryServices(Configuration);
 
         services.AddSwaggerGen(o =>
         {
             o.OperationFilter<SwaggerDefaultValues>();
         });
+
+        services.AddHealthChecks();
     }
 
     // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
@@ -64,6 +67,7 @@ namespace ServerManager.WebApplication
             app.UseDeveloperExceptionPage();
         }
 
+
         var enableSwagger = Configuration.GetValue<bool>("EnableSwagger");
         if (enableSwagger)
         {
@@ -95,7 +99,10 @@ namespace ServerManager.WebApplication
         app.UseEndpoints(endpoints =>
         {
             endpoints.MapControllers();
+            endpoints.MapHealthChecks("/api/health", new HealthCheckOptions()
+            {
+                AllowCachingResponses = false
+            });
         });
     }
 }
-}

src/ServerManager.WebApplication/appsettings.Development.json

@@ -7,9 +7,10 @@
     }
   },
 
-  "EnableSwagger": false,
+  "EnableSwagger": true,
   "SwaggerRoutePrefix": "",
 
+  "ServerQuerySettings": {
     "ManagerCodes": [
       {
         "Name": "Unknown",
@@ -17,3 +18,4 @@
       }
     ]
   }
+}

src/ServerManager.WebApplication/appsettings.Production.json

@@ -2,6 +2,7 @@
   "EnableSwagger": false,
   "SwaggerRoutePrefix": "",
 
+  "ServerQuerySettings": {
     "ManagerCodes": [
       {
         "Name": "Unknown",
@@ -17,3 +18,4 @@
       }
     ]
   }
+}