added swagger for automatic API Documentation

Reviewed-on: #29

.gitea/workflows/build.yml

@@ -8,7 +8,7 @@ on:
 
 env:
   DOTNET_VERSION: '8.0.x'
-  DOCKER_IMAGE_NAME: watcher
+  DOCKER_IMAGE_NAME: watcher-server
   REGISTRY_URL: git.triggermeelmo.com
   DOCKER_PLATFORMS: 'linux/amd64,linux/arm64'
 
@@ -17,7 +17,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build-and-test:
+  dotnet-build-and-test:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -43,7 +43,7 @@ jobs:
 
   set-tag:
     name: Set Tag Name
-    needs: [build-and-test]
+    needs: [dotnet-build-and-test]
     #if: ${{ !failure() && !cancelled() && github.event_name != 'pull_request' }}
     runs-on: ubuntu-latest
     outputs:
@@ -95,7 +95,7 @@ jobs:
 
   docker-build-and-push:
     runs-on: ubuntu-latest
-    needs: [build-and-test, set-tag]
+    needs: [dotnet-build-and-test, set-tag]
     if: | 
       needs.set-tag.outputs.should_tag == 'true' &&
       github.event_name != 'pull_request'
@@ -123,6 +123,9 @@ jobs:
   tag:
     name: Create Tag
     needs: [docker-build-and-push, set-tag]
+    if: |
+      needs.set-tag.outputs.should_tag == 'true' &&
+      github.event_name != 'pull_request'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

Watcher/Program.cs

@@ -1,5 +1,6 @@
 using Microsoft.AspNetCore.Authentication.OpenIdConnect;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.OpenApi.Models;
 
 using Serilog;
 
@@ -36,11 +37,17 @@ builder.Services.AddHttpContextAccessor();
 
 // Storage Singleton
 builder.Services.AddSingleton<IDashboardStore, DashboardStore>();
+builder.Services.AddSingleton<ISystemStore, SystemStore>();
 
 // Background Services
 builder.Services.AddHostedService<NetworkCheck>();
 builder.Services.AddHostedService<DatabaseCheck>();
 
+// Swagger API-Dokumentation
+builder.Services.AddSwaggerGen(options =>
+{
+    options.SwaggerDoc("v1", new OpenApiInfo { Title = "Watcher-Server API", Version = "v1" });
+});
 
 // ---------- Konfiguration ----------
 DotNetEnv.Env.Load();
@@ -212,6 +219,8 @@ if (!app.Environment.IsDevelopment())
 app.UseHttpsRedirection();
 app.UseRouting();
 
+app.UseSwagger();
+
 app.UseAuthentication();
 app.UseAuthorization();
 
@@ -222,4 +231,11 @@ app.MapControllerRoute(
     pattern: "{controller=Home}/{action=Index}/{id?}"
     );
 
+app.MapSwagger();
+
+app.UseSwaggerUI(options =>
+{
+    options.SwaggerEndpoint("v1/swagger.json", "Watcher-Server API v1");
+});
+
 app.Run();

Watcher/Services/ISystemStore.cs

@@ -0,0 +1,9 @@
+namespace Watcher.Services;
+
+public interface ISystemStore
+{
+    Boolean NewVersionAvailable { get; set; }
+
+    Double DatabaseSize { get; set; }
+
+}

Watcher/Services/SystemMangement.cs

@@ -0,0 +1,42 @@
+using System.Net.Http;
+
+namespace Watcher.Services;
+
+public class SystemManagement : BackgroundService
+{
+    private readonly ILogger<NetworkCheck> _logger;
+
+    private ISystemStore _SystemStore;
+
+    public SystemManagement(ILogger<NetworkCheck> logger, ISystemStore SystemStore)
+    {
+        _logger = logger;
+        _SystemStore = SystemStore;
+
+    }
+
+    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
+    {
+        // Todo: Umstellen auf einmal alle 24h
+        var timer = new PeriodicTimer(TimeSpan.FromSeconds(30));
+
+        while (await timer.WaitForNextTickAsync(stoppingToken))
+        {
+            // Hintergrundprozess abwarten
+            await checkForNewDockerImageVersion();
+
+            // 5 Sekdunden Offset
+            await Task.Delay(TimeSpan.FromSeconds(5), stoppingToken);
+        }
+    }
+
+    public Task checkForNewDockerImageVersion()
+    {
+        return Task.CompletedTask;
+    }
+
+    public Task createDailySqliteBackup()
+    {
+        return Task.CompletedTask;
+    }
+}

Watcher/Services/SystemStore.cs

@@ -0,0 +1,9 @@
+namespace Watcher.Services;
+
+public class SystemStore: ISystemStore
+{
+    public Boolean NewVersionAvailable { get; set; }
+
+    public Double DatabaseSize { get; set; }
+
+}

Watcher/Watcher.csproj

@@ -23,6 +23,7 @@
     <PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="8.0.6" />
     <PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
     <PackageReference Include="Serilog.Sinks.File" Version="7.0.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.6" />
   </ItemGroup>
 
 </Project>