From 4186388d4c7e515b66e9eee9c78cae2138ed7887 Mon Sep 17 00:00:00 2001
From: Laura Hausmann <laura@hausmann.dev>
Date: Mon, 18 Nov 2024 18:18:01 +0100
Subject: [PATCH] [backend/openapi] Add scalar-ui, add OpenAPI overview page

---
 .../Extensions/WebApplicationExtensions.cs    | 15 +++++++++++
 Iceshrimp.Backend/Iceshrimp.Backend.csproj    |  1 +
 Iceshrimp.Backend/Pages/OpenApi.razor         | 25 +++++++++++++++++++
 Iceshrimp.Backend/Pages/OpenApi.razor.css     |  8 ++++++
 4 files changed, 49 insertions(+)
 create mode 100644 Iceshrimp.Backend/Pages/OpenApi.razor
 create mode 100644 Iceshrimp.Backend/Pages/OpenApi.razor.css

diff --git a/Iceshrimp.Backend/Core/Extensions/WebApplicationExtensions.cs b/Iceshrimp.Backend/Core/Extensions/WebApplicationExtensions.cs
index 9735e346..79ebf4ef 100644
--- a/Iceshrimp.Backend/Core/Extensions/WebApplicationExtensions.cs
+++ b/Iceshrimp.Backend/Core/Extensions/WebApplicationExtensions.cs
@@ -10,6 +10,7 @@ using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Migrations;
 using Microsoft.Extensions.Configuration.Ini;
 using Microsoft.Extensions.Options;
+using Scalar.AspNetCore;
 
 namespace Iceshrimp.Backend.Core.Extensions;
 
@@ -52,6 +53,20 @@ public static class WebApplicationExtensions
 			options.ConfigObject.AdditionalItems.Add("tagsSorter", "alpha"); // Sort tags alphabetically
 		});
 
+		app.MapScalarApiReference(options =>
+		{
+			options.Title               = "Iceshrimp API documentation";
+			options.OpenApiRoutePattern = "/openapi/{documentName}.json";
+			options.EndpointPathPrefix  = "/scalar/{documentName}";
+			options.HideModels          = true;
+
+			options.CustomCss = """
+			                    .open-api-client-button, .darklight-reference-promo { display: none !important; }
+			                    .darklight { height: 14px !important; }
+			                    .darklight-reference { padding: 14px !important; }
+			                    """;
+		});
+
 		return app;
 	}
 
diff --git a/Iceshrimp.Backend/Iceshrimp.Backend.csproj b/Iceshrimp.Backend/Iceshrimp.Backend.csproj
index 1629eb88..e084f20e 100644
--- a/Iceshrimp.Backend/Iceshrimp.Backend.csproj
+++ b/Iceshrimp.Backend/Iceshrimp.Backend.csproj
@@ -36,6 +36,7 @@
         <PackageReference Include="Microsoft.EntityFrameworkCore.Relational" Version="9.0.0" />
         <PackageReference Include="Microsoft.Extensions.Configuration.Ini" Version="9.0.0" />
         <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.0.0" />
+        <PackageReference Include="Scalar.AspNetCore" Version="1.2.39" />
         <PackageReference Include="SixLabors.ImageSharp.Drawing" Version="2.1.4" />
         <PackageReference Include="SixLabors.ImageSharp" Version="3.1.6-iceshrimp" />
         <PackageReference Include="Swashbuckle.AspNetCore" Version="7.0.0" />
diff --git a/Iceshrimp.Backend/Pages/OpenApi.razor b/Iceshrimp.Backend/Pages/OpenApi.razor
new file mode 100644
index 00000000..64814d99
--- /dev/null
+++ b/Iceshrimp.Backend/Pages/OpenApi.razor
@@ -0,0 +1,25 @@
+@page "/openapi"
+@attribute [Route("/scalar")]
+@using Microsoft.Extensions.Options
+@using Swashbuckle.AspNetCore.SwaggerGen
+@inject IOptions<SwaggerGenOptions> Options;
+
+<h2>OpenAPI definitions</h2>
+<p>Please select a OpenAPI document below.</p>
+<table class="auto-table">
+    <thead>
+    <th class="width0">Document</th>
+    <th>Links</th>
+    </thead>
+    @foreach (var doc in Options.Value.SwaggerGeneratorOptions.SwaggerDocs)
+    {
+        <tr>
+            <td>@doc.Value.Title</td>
+            <td>
+                <a href="/openapi/@(doc.Key).json">JSON</a> -
+                <a href="/swagger/index.html?urls.primaryName=@(doc.Value.Title)">SwaggerUI</a> -
+                <a href="/scalar/@(doc.Key)">ScalarUI</a>
+            </td>
+        </tr>
+    }
+</table>
\ No newline at end of file
diff --git a/Iceshrimp.Backend/Pages/OpenApi.razor.css b/Iceshrimp.Backend/Pages/OpenApi.razor.css
new file mode 100644
index 00000000..8c9f7a5f
--- /dev/null
+++ b/Iceshrimp.Backend/Pages/OpenApi.razor.css
@@ -0,0 +1,8 @@
+.width0 {
+    width: 0;
+}
+
+.auto-table {
+    table-layout: auto;
+    width: 100%;
+}
\ No newline at end of file