Add new controllers to custom apismaster

Source/Applications/openPDC/openPDC/App.config

@@ -44,7 +44,7 @@
       <add name="BootstrapTheme" value="Content/bootstrap-theme.min.css" description="Path to Bootstrap CSS to use for rendering styles." encrypted="false"/>
       <add name="AuthenticationSchemes" value="Ntlm, Basic" description="Comma separated list of authentication schemes to use for clients accessing the hosted web server, e.g., Basic or NTLM." encrypted="false"/>
       <add name="AuthFailureRedirectResourceExpression" value="^/$|^/.+\.cshtml$|^/.+\.vbhtml$|^/grafana(?!/api/).*$" description="Expression that will match paths for the resources on the web server that should redirect to the LoginPage when authentication fails." encrypted="false"/>
-      <add name="AnonymousResourceExpression" value="^/@|^/Scripts/|^/Content/|^/Images/|^/fonts/|^/favicon.ico$|^/api/grafana(/|$)" description="Expression that will match paths for the resources on the web server that can be provided without checking credentials." encrypted="false"/>
+      <add name="AnonymousResourceExpression" value="^/@|^/Scripts/|^/Content/|^/Images/|^/fonts/|^/favicon.ico$|^/api/grafana(/|$)|^/swagger" description="Expression that will match paths for the resources on the web server that can be provided without checking credentials." encrypted="false"/>
       <add name="AuthenticationToken" value="x-gsf-auth" description="Defines the token used for identifying the authentication token in cookie headers." encrypted="false"/>
       <add name="SessionToken" value="x-gsf-session" description="Defines the token used for identifying the session ID in cookie headers." encrypted="false"/>
       <add name="RequestVerificationToken" value="X-GSF-Verify" description="Defines the token used for anti-forgery verification in HTTP request headers." encrypted="false"/>

Source/Applications/openPDC/openPDC/AppDebug.config

@@ -46,7 +46,7 @@
       <add name="BootstrapTheme" value="Content/bootstrap-theme.min.css" description="Path to Bootstrap CSS to use for rendering styles." encrypted="false" />
       <add name="AuthenticationSchemes" value="Ntlm, Basic" description="Comma separated list of authentication schemes to use for clients accessing the hosted web server, e.g., Basic or NTLM." encrypted="false" />
       <add name="AuthFailureRedirectResourceExpression" value="^/$|^/.+\.cshtml$|^/.+\.vbhtml$|^/grafana(?!/api/)" description="Expression that will match paths for the resources on the web server that should redirect to the LoginPage when authentication fails." encrypted="false" />
-      <add name="AnonymousResourceExpression" value="^/@|^/Scripts/|^/Content/|^/Images/|^/fonts/|^/favicon.ico$|^/api/grafana(/|$)" description="Expression that will match paths for the resources on the web server that can be provided without checking credentials." encrypted="false" />
+			<add name="AnonymousResourceExpression" value="^/@|^/Scripts/|^/Content/|^/Images/|^/fonts/|^/favicon.ico$|^/api/grafana(/|$)|^/swagger" description="Expression that will match paths for the resources on the web server that can be provided without checking credentials." encrypted="false" />
       <add name="AuthenticationToken" value="x-gsf-auth" description="Defines the token used for identifying the authentication token in cookie headers." encrypted="false" />
       <add name="SessionToken" value="x-gsf-session" description="Defines the token used for identifying the session ID in cookie headers." encrypted="false" />
       <add name="LoginPage" value="/@GSF/Web/Security/Views/Login.cshtml" description="Defines the login page used for redirects on authentication failure. Expects forward slash prefix." encrypted="false" />

Source/Applications/openPDC/openPDC/Startup.cs

@@ -21,11 +21,6 @@
 //
 //******************************************************************************************************
 
-using System;
-using System.Security;
-using System.Web.Http;
-using System.Web.Http.Cors;
-using System.Web.Http.ExceptionHandling;
 using GSF.IO;
 using GSF.Web;
 using GSF.Web.Hosting;
@@ -36,9 +31,16 @@
 using ModbusAdapters;
 using Newtonsoft.Json;
 using openPDC.Adapters;
-using Owin;
 using openPDC.Model;
+using Owin;
 using PhasorWebUI;
+using Swashbuckle.Application;
+using System;
+using System.IO;
+using System.Security;
+using System.Web.Http;
+using System.Web.Http.Cors;
+using System.Web.Http.ExceptionHandling;
 
 namespace openPDC
 {
@@ -53,6 +55,11 @@ public override void Handle(ExceptionHandlerContext context)
 
     public class Startup
     {
+        /// <summary>
+        /// Gets the authentication options used for the hosted web server.
+        /// </summary>
+        public static AuthenticationOptions AuthenticationOptions { get; } = new AuthenticationOptions();
+
         public void Configuration(IAppBuilder app)
         {
             // Add Content-Security Headers
@@ -62,7 +69,9 @@ public void Configuration(IAppBuilder app)
                 {
                     await next();
 
-                    if (!context.Response.Headers.ContainsKey("Content-Security-Policy"))
+                    bool isSwaggerPath = context.Request.Path.Value?.StartsWith("/swagger", StringComparison.OrdinalIgnoreCase) == true;
+
+                    if (!isSwaggerPath && !context.Response.Headers.ContainsKey("Content-Security-Policy"))
                         context.Response.Headers.Add("Content-Security-Policy", ["default-src: 'self'"]);
 
                     if (context.Request.Scheme == "https" && !context.Response.Headers.ContainsKey("Strict-Transport-Security"))
@@ -77,15 +86,16 @@ public void Configuration(IAppBuilder app)
                 }
             });
 
-            // Modify the JSON serializer to serialize dates as UTC - otherwise, timezone will not be appended
-            // to date strings and browsers will select whatever timezone suits them
+            // Modify the JSON serializer to serialize dates as UTC - otherwise, timezone will not
+            // be appended to date strings and browsers will select whatever timezone suits them
             JsonSerializerSettings settings = JsonUtility.CreateDefaultSerializerSettings();
             settings.DateTimeZoneHandling = DateTimeZoneHandling.Utc;
             JsonSerializer serializer = JsonSerializer.Create(settings);
             GlobalHost.DependencyResolver.Register(typeof(JsonSerializer), () => serializer);
             AppModel model = Program.Host.Model;
 
-            // Load security hub into application domain before establishing SignalR hub configuration, initializing default status and exception handlers
+            // Load security hub into application domain before establishing SignalR hub
+            // configuration, initializing default status and exception handlers
             try
             {
                 using (new SecurityHub(
@@ -119,7 +129,7 @@ public void Configuration(IAppBuilder app)
                     Program.Host.LogException
                 ))
                 {
-                    WebExtensions.AddEmbeddedResourceAssembly(hub.GetType().Assembly);                  
+                    WebExtensions.AddEmbeddedResourceAssembly(hub.GetType().Assembly);
                 }
             }
             catch (Exception ex)
@@ -145,9 +155,8 @@ public void Configuration(IAppBuilder app)
             // Enable GSF role-based security authentication
             app.UseAuthentication(AuthenticationOptions);
 
-            // Enable cross-domain scripting default policy - controllers can manually
-            // apply "EnableCors" attribute to class or an action to override default
-            // policy configured here
+            // Enable cross-domain scripting default policy - controllers can manually apply
+            // "EnableCors" attribute to class or an action to override default policy configured here
             try
             {
                 if (!string.IsNullOrWhiteSpace(model.Global.DefaultCorsOrigins))
@@ -180,6 +189,12 @@ public void Configuration(IAppBuilder app)
             {
                 using (new GrafanaController()) { }
 
+                using (new DeviceController()) { }
+
+                using (new PhasorController()) { }
+
+                using (new DevicePhasorController()) { }
+
                 httpConfig.Routes.MapHttpRoute(
                     name: "CustomAPIs",
                     routeTemplate: "api/{controller}/{action}/{id}",
@@ -194,6 +209,30 @@ public void Configuration(IAppBuilder app)
             // Set configuration to use reflection to setup routes
             httpConfig.MapHttpAttributeRoutes();
 
+            // Configure Swagger UI for custom API documentation
+            try
+            {
+                httpConfig.EnableSwagger(c =>
+                {
+                    c.SingleApiVersion("v1", "openPDC Custom APIs")
+                        .Description("REST API endpoints for device management and phasor data in openPDC.");
+
+                    string baseDir = AppDomain.CurrentDomain.BaseDirectory;
+
+                    string openPDCXml = Path.Combine(baseDir, "openPDC.xml");
+                    if (File.Exists(openPDCXml))
+                        c.IncludeXmlComments(openPDCXml);
+
+                    string adaptersXml = Path.Combine(baseDir, "openPDC.Adapters.xml");
+                    if (File.Exists(adaptersXml))
+                        c.IncludeXmlComments(adaptersXml);
+                }).EnableSwaggerUi();
+            }
+            catch (Exception ex)
+            {
+                Program.Host.LogException(new InvalidOperationException($"Failed to initialize Swagger: {ex.Message}", ex));
+            }
+
             // Load the WebPageController class and assign its routes
             app.UseWebApi(httpConfig);
 
@@ -208,8 +247,8 @@ private void Load_ModbusAssembly()
         {
             try
             {
-                // Wrap class reference in lambda function to force
-                // assembly load errors to occur within the try-catch
+                // Wrap class reference in lambda function to force assembly load errors to occur
+                // within the try-catch
                 new Action(() =>
                 {
                     // Make embedded resources of Modbus poller available to web server
@@ -224,12 +263,7 @@ private void Load_ModbusAssembly()
                 Program.Host.LogException(new InvalidOperationException($"Failed to load Modbus assembly: {ex.Message}", ex));
             }
         }
-
-        // Static Properties
 
-        /// <summary>
-        /// Gets the authentication options used for the hosted web server.
-        /// </summary>
-        public static AuthenticationOptions AuthenticationOptions { get; } = new AuthenticationOptions();
+        // Static Properties
     }
-}
+}

Source/Applications/openPDC/openPDC/openPDC.csproj

@@ -57,6 +57,7 @@
     <OutputPath>..\..\..\..\Build\Output\Debug\Applications\openPDC\</OutputPath>
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
+    <DocumentationFile>..\..\..\..\Build\Output\Debug\Applications\openPDC\openPDC.xml</DocumentationFile>
     <WarningLevel>4</WarningLevel>
     <UseVSHostingProcess>false</UseVSHostingProcess>
     <CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
@@ -73,6 +74,7 @@
     <WarningLevel>4</WarningLevel>
     <CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
     <Prefer32Bit>false</Prefer32Bit>
+    <DocumentationFile>..\..\..\..\Build\Output\Release\Applications\openPDC\openPDC.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
     <DebugSymbols>true</DebugSymbols>
@@ -118,6 +120,10 @@
     <CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="Swashbuckle.Core">
+      <SpecificVersion>False</SpecificVersion>
+      <HintPath>..\..\..\Dependencies\GSF\Swashbuckle.Core.dll</HintPath>
+    </Reference>
     <Reference Include="AjaxMin, Version=5.14.5506.26196, Culture=neutral, PublicKeyToken=21ef50ce11b5d80f, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\..\..\Dependencies\GSF\AjaxMin.dll</HintPath>

Source/Applications/openPDC/openPDCSetup/openPDCSetup.wxs

@@ -1131,6 +1131,11 @@
           <netfx:NativeImage Id="ngen_System.Web.Http.Cors.dll" Platform="64bit" Priority="0" AppBaseDirectory="INSTALLFOLDER"/>
         </File>
       </Component>
+      <Component Id="Swashbuckle.Core">
+        <File Id="Swashbuckle.Core.dll" Name="Swashbuckle.Core.dll" Source="$(var.SolutionDir)\Dependencies\GSF\Swashbuckle.Core.dll">
+          <netfx:NativeImage Id="ngen_Swashbuckle.Core.dll" Platform="64bit" Priority="0" AppBaseDirectory="INSTALLFOLDER"/>
+        </File>
+      </Component>
       <Component Id="Microsoft.Owin">
         <File Id="Microsoft.Owin.dll" Name="Microsoft.Owin.dll" Source="$(var.SolutionDir)\Dependencies\GSF\Microsoft.Owin.dll">
           <netfx:NativeImage Id="ngen_Microsoft.Owin.dll" Platform="64bit" Priority="0" AppBaseDirectory="INSTALLFOLDER"/>

Source/Libraries/openPDC.Adapters/Constants/StringConstant.cs

@@ -0,0 +1,14 @@
+namespace openPDC.Adapters.Constants
+{
+    internal static class StringConstant
+    {
+        #region [ Constants ]
+
+        internal const string Acronym = "Acronym";
+        internal const string DeviceID = "DeviceID";
+        internal const string SourceIndex = "SourceIndex";
+        internal const string SystemSettings = "systemSettings";
+
+        #endregion [ Constants ]
+    }
+}