Add Scalar API browser

Kaliumhexacyanoferrat · Dec 16, 2024 · e53bc74 · e53bc74
1 parent 488e804
commit e53bc74
Show file tree

Hide file tree

Showing 6 changed files with 107 additions and 0 deletions.
diff --git a/Modules/ApiBrowsing/ApiBrowser.cs b/Modules/ApiBrowsing/ApiBrowser.cs
@@ -21,4 +21,10 @@ public static class ApiBrowser
     /// <returns>The newly created handler</returns>
     public static BrowserHandlerBuilder Redoc() => new("Redoc", "Redoc");
 
+    /// <summary>
+    /// Creates a handler that will provide a Scalar app.
+    /// </summary>
+    /// <returns>The newly created handler</returns>
+    public static BrowserHandlerBuilder Scalar() => new("Scalar", "Scalar");
+
 }
diff --git a/Modules/ApiBrowsing/Extensions.cs b/Modules/ApiBrowsing/Extensions.cs
@@ -38,6 +38,22 @@ public static LayoutBuilder AddSwaggerUI(this LayoutBuilder layout, string segme
     public static LayoutBuilder AddRedoc(this LayoutBuilder layout, string segment = "redoc", string? url = null, string? title = null)
         => AddBrowser(layout, ApiBrowser.Redoc(), segment, url, title);
 
+    /// <summary>
+    /// Creates a Scalar application and registers it at the layout.
+    /// </summary>
+    /// <param name="layout">The layout to add the application to</param>
+    /// <param name="segment">The path to make the application available from (defaults to "/scalar/")</param>
+    /// <param name="url">The URL of the Open API definition to be rendered (defaults to "../openapi.json")</param>
+    /// <param name="title">The title of the rendered application</param>
+    /// <returns>The layout once again (builder pattern)</returns>
+    /// <remarks>
+    /// There is no auto-detection of Open API definitions provided by the server
+    /// so the URL provided needs to point to the correct definition to be consumed.
+    /// Use relative paths to avoid issues with CORS, proxies etc.
+    /// </remarks>
+    public static LayoutBuilder AddScalar(this LayoutBuilder layout, string segment = "scalar", string? url = null, string? title = null)
+        => AddBrowser(layout, ApiBrowser.Scalar(), segment, url, title);
+
     private static LayoutBuilder AddBrowser(this LayoutBuilder layout, BrowserHandlerBuilder builder, string segment, string? url, string? title)
     {
         if (url != null)

diff --git a/Modules/ApiBrowsing/GenHTTP.Modules.ApiBrowsing.csproj b/Modules/ApiBrowsing/GenHTTP.Modules.ApiBrowsing.csproj
@@ -65,12 +65,19 @@
       <EmbeddedResource Include="Redoc\Index.html" />
       <EmbeddedResource Include="Redoc\Static\redoc-standalone.js" />
       <EmbeddedResource Include="Redoc\Static\roboto.css" />
+      <EmbeddedResource Include="Scalar\Index.html" />
       <EmbeddedResource Include="Swagger\Index.html" />
       <EmbeddedResource Include="Swagger\Static\swagger-ui-bundle.js" />
       <EmbeddedResource Include="Swagger\Static\swagger-ui.css" />
       <None Remove="Redoc\Resources\Index.html" />
       <None Remove="Redoc\Resources\Static\redoc.standalone.js" />
       <None Remove="Redoc\Resources\Static\roboto.css" />
+      <None Remove="Scalar\Static\scalar.js" />
+      <EmbeddedResource Include="Scalar\Static\scalar.js" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <Folder Include="Scalar\Static\" />
     </ItemGroup>
 
 </Project>
diff --git a/Modules/ApiBrowsing/Scalar/Index.html b/Modules/ApiBrowsing/Scalar/Index.html
@@ -0,0 +1,15 @@
+<!doctype html>
+<html>
+<head>
+    <title>{title}</title>
+    <meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1"/>
+</head>
+<body>
+
+    <script id="api-reference" data-url="{url}"></script>
+
+    <script src="./static/scalar.js"></script>
+
+</body>
+</html>
diff --git a/Modules/ApiBrowsing/Scalar/Static/scalar.js b/Modules/ApiBrowsing/Scalar/Static/scalar.js
diff --git a/Testing/Acceptance/Modules/ApiBrowsing/ApplicationTests.cs b/Testing/Acceptance/Modules/ApiBrowsing/ApplicationTests.cs
@@ -47,4 +47,22 @@ public async Task TestRedoc(TestEngine engine)
         AssertX.Contains("Redoc", await response.GetContentAsync());
     }
 
+    [TestMethod]
+    [MultiEngineTest]
+    public async Task TestScalar(TestEngine engine)
+    {
+        var app = Layout.Create()
+                        .Add(Inline.Create().Get(() => 42))
+                        .AddOpenApi()
+                        .AddScalar();
+
+        await using var host = await TestHost.RunAsync(app, engine: engine);
+
+        using var response = await host.GetResponseAsync("/scalar/");
+
+        await response.AssertStatusAsync(HttpStatusCode.OK);
+
+        AssertX.Contains("Scalar", await response.GetContentAsync());
+    }
+
 }