openAPISwaggerUI–part 3–add UI for all

This is how I made

https://nuget.org/packages/OpenAPISwaggerUI in order to see the UI for an ASP.NET 9 project.

And hey,if you have any feedback,don’t be shy! Drop by https://github.com/ignatandrei/openAPISwaggerUI/ and let me know.

Now I want the users of my ASP.NET 9 project to have a buffet of Swagger UIs (Swashbuckle,Redoc,Scalar,NSwag,VisualAutomation) and let them pick their favorite flavor.

The master plan? Create an endpoint (let’s call it /swagger) that showcases all these UIs like a proud parent at a talent show.

But wait,there’s more! I want to sprinkle in some custom info – project version,UI links,and other goodies.

Enter the RazorBlade NuGet package,my trusty sidekick for crafting a Razor page.

So I used the RazorBlade nuget package to create a Razor page .

&lt;ItemGroup&gt;
	&lt;PackageReference Include=&quot;RazorBlade&quot; Version=&quot;0.7.0&quot; PrivateAssets=&quot;all&quot; ReferenceOutputAssembly=&quot;false&quot; OutputItemType=&quot;Analyzer&quot; /&gt;
&lt;/ItemGroup&gt;

And voilà,the SwaggerData.cshtml Razor page is born:

@using OpenAPISwaggerUI
@inherits RazorBlade.PlainTextTemplate&lt;SwaggerUIData&gt;

&lt;html&gt;
&lt;body&gt;
    &lt;h1&gt;Swagger UI&lt;/h1&gt;
    &lt;h2&gt;
        &lt;a href=&quot;@Model.SwaggerEndpoint&quot; target=&quot;_blank&quot;&gt;SwaggerEndpoint&lt;/a&gt;
    &lt;/h2&gt;
    &lt;ul&gt;
        &lt;li&gt;
            &lt;a href=&quot;@Model.Swashbuckle&quot; target=&quot;_blank&quot;&gt;Swashbuckle&lt;/a&gt;
        &lt;/li&gt;
        &lt;li&gt;
            &lt;a href=&quot;@Model.NSwag&quot; target=&quot;_blank&quot;&gt;NSwag&lt;/a&gt;
        &lt;/li&gt;
        &lt;li&gt;
            &lt;a href=&quot;@Model.ReDoc&quot; target=&quot;_blank&quot;&gt;Redoc&lt;/a&gt;
        &lt;/li&gt;
        &lt;li&gt;
            &lt;a href=&quot;@Model.Scalar&quot; target=&quot;_blank&quot;&gt;Scalar&lt;/a&gt;
        &lt;/li&gt;
        &lt;li&gt;
            &lt;a href=&quot;@Model.Blockly&quot; target=&quot;_blank&quot;&gt;VisualAutomation&lt;/a&gt;
        &lt;/li&gt;
    &lt;/ul&gt;
    &lt;small&gt;
        Generated by &lt;a href=&quot;https://www.nuget.org/packages/OpenAPISwaggerUI&quot; target=&quot;_blank&quot;&gt; @Model.AssemblyName : @Model.MyName&lt;/a&gt;
    &lt;/small&gt;
&lt;/body&gt;
&lt;/html&gt;

Posted

2025-02-19

.NET, openAPI, projects, swagger

ignatandrei

Tags:

openAPISwaggerUI–part 3–add UI for all

Comments

Leave a Reply Cancel reply