Add Swagger UI to service frameworks (#18)

Kaliumhexacyanoferrat · Dec 23, 2024 · bf6998c · bf6998c
1 parent d9a4cfb
commit bf6998c
Show file tree

Hide file tree

Showing 20 changed files with 145 additions and 48 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -34,3 +34,59 @@ jobs:
     - name: End scan
       if: env.SONAR_TOKEN != null && env.SONAR_TOKEN != ''
       run: dotnet sonarscanner end /d:sonar.token="$SONAR_TOKEN"
+    - name: Install templates
+      run: dotnet new install .
+    - name: Test webservice framework
+      run: |
+       mkdir -p /tmp/genhttp/webservice/
+       cd /tmp/genhttp/webservice/
+       dotnet new genhttp-webservice
+       cd webservice.Tests
+       dotnet test
+       cd /tmp/genhttp/webservice/
+       rm -rf ./webservice/bin/
+       rm -rf ./webservice/obj/
+       docker build -f Dockerfile.linux-x64 -t webservice .
+    - name: Test controller framework
+      run: |
+       mkdir -p /tmp/genhttp/controllers/
+       cd /tmp/genhttp/controllers/
+       dotnet new genhttp-webservice-controllers
+       cd controllers.Tests
+       dotnet test
+       cd /tmp/genhttp/controllers/
+       rm -rf ./controllers/bin/
+       rm -rf ./controllers/obj/
+       docker build -f Dockerfile.linux-x64 -t controllers .
+    - name: Test minimal framework
+      run: |
+       mkdir -p /tmp/genhttp/minimal/
+       cd /tmp/genhttp/minimal/
+       dotnet new genhttp-webservice-minimal
+       cd minimal.Tests
+       cd /tmp/genhttp/minimal/
+       rm -rf ./minimal/bin/
+       rm -rf ./minimal/obj/
+       docker build -f Dockerfile.linux-x64 -t minimal .
+    - name: Test static website
+      run: |
+       mkdir -p /tmp/genhttp/website/
+       cd /tmp/genhttp/website/
+       dotnet new genhttp-website-static
+       cd website.Tests
+       dotnet test
+       cd /tmp/genhttp/website/
+       rm -rf ./website/bin/
+       rm -rf ./website/obj/
+       docker build -f Dockerfile.linux-x64 -t website .
+    - name: Test websockets
+      run: |
+       mkdir -p /tmp/genhttp/websockets/
+       cd /tmp/genhttp/websockets/
+       dotnet new genhttp-websocket
+       cd websockets.Tests
+       dotnet test
+       cd /tmp/genhttp/websockets/
+       rm -rf ./websockets/bin/
+       rm -rf ./websockets/obj/
+       docker build -f Dockerfile.linux-x64 -t websocket .
diff --git a/GenHTTP.Templates.csproj b/GenHTTP.Templates.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
 
     <PackageType>Template</PackageType>
-    <PackageVersion>9.3</PackageVersion>
+    <PackageVersion>9.4</PackageVersion>
     <PackageId>GenHTTP.Templates</PackageId>
 
     <Title>GenHTTP Templates</Title>

diff --git a/Templates/SinglePageApplication/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj b/Templates/SinglePageApplication/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj
@@ -19,7 +19,7 @@
     <PackageReference Include="MSTest.TestAdapter" Version="3.6.4" />
     <PackageReference Include="MSTest.TestFramework" Version="3.6.4" />
 
-    <PackageReference Include="GenHTTP.Testing" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Testing" Version="9.4.0" />
 
     <ProjectReference Include="..\$safeprojectname$\$safeprojectname$.csproj" />
 

diff --git a/Templates/SinglePageApplication/$safeprojectname$/$safeprojectname$.csproj b/Templates/SinglePageApplication/$safeprojectname$/$safeprojectname$.csproj
@@ -19,12 +19,9 @@
 
   <ItemGroup>
 
-    <PackageReference Include="GenHTTP.Core" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Core" Version="9.4.0" />
 
-    <PackageReference Include="GenHTTP.Modules.SinglePageApplications" Version="9.3.0" />
-
-	<!-- see https://github.com/dotnet/sdk/issues/42651 -->
-	<NuGetAuditSuppress Include="https://github.com/advisories/GHSA-5f2m-466j-3848;https://github.com/advisories/GHSA-x5qj-9vmx-7g6g;https://github.com/advisories/GHSA-xhfc-gr8f-ffwc" />
+    <PackageReference Include="GenHTTP.Modules.SinglePageApplications" Version="9.4.0" />
 
   </ItemGroup>
 

diff --git a/Templates/Webservice-Controllers/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj b/Templates/Webservice-Controllers/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj
@@ -19,7 +19,7 @@
     <PackageReference Include="MSTest.TestAdapter" Version="3.6.4" />
 	<PackageReference Include="MSTest.TestFramework" Version="3.6.4" />
 
-    <PackageReference Include="GenHTTP.Testing" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Testing" Version="9.4.0" />
 
     <ProjectReference Include="..\$safeprojectname$\$safeprojectname$.csproj" />
 

diff --git a/Templates/Webservice-Controllers/$safeprojectname$/$safeprojectname$.csproj b/Templates/Webservice-Controllers/$safeprojectname$/$safeprojectname$.csproj
@@ -19,14 +19,12 @@
 
   <ItemGroup>
 
-    <PackageReference Include="GenHTTP.Core" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Core" Version="9.4.0" />
 
-    <PackageReference Include="GenHTTP.Modules.Security" Version="9.3.0" />
-	<PackageReference Include="GenHTTP.Modules.Controllers" Version="9.3.0" />
-    <PackageReference Include="GenHTTP.Modules.OpenApi" Version="9.3.0" />
-
-    <!-- see https://github.com/dotnet/sdk/issues/42651 -->
-	<NuGetAuditSuppress Include="https://github.com/advisories/GHSA-5f2m-466j-3848;https://github.com/advisories/GHSA-x5qj-9vmx-7g6g;https://github.com/advisories/GHSA-xhfc-gr8f-ffwc" />
+    <PackageReference Include="GenHTTP.Modules.Security" Version="9.4.0" />
+	<PackageReference Include="GenHTTP.Modules.Controllers" Version="9.4.0" />
+    <PackageReference Include="GenHTTP.Modules.OpenApi" Version="9.4.0" />
+    <PackageReference Include="GenHTTP.Modules.ApiBrowsing" Version="9.4.0" />
 
   </ItemGroup>
 

diff --git a/Templates/Webservice-Controllers/$safeprojectname$/Program.cs b/Templates/Webservice-Controllers/$safeprojectname$/Program.cs
@@ -4,6 +4,24 @@
 
 using $safeprojectname$;
 
+//
+// GenHTTP Controller Framework Template
+//
+// URLs:
+//   http://localhost:8080/devices/
+//   http://localhost:8080/docs/
+//   http://localhost:8080/openapi.json
+//
+// Framework documentation:
+//   https://genhttp.org/documentation/content/frameworks/controllers/
+//
+// Method definitions:
+//   https://genhttp.org/documentation/content/concepts/definitions/
+//
+// Additional features:
+//   https://genhttp.org/documentation/content/
+//
+
 var project = Project.Setup();
 
 return await Host.Create()

diff --git a/Templates/Webservice-Controllers/$safeprojectname$/Project.cs b/Templates/Webservice-Controllers/$safeprojectname$/Project.cs
@@ -4,6 +4,7 @@
 using GenHTTP.Modules.Security;
 using GenHTTP.Modules.Controllers;
 using GenHTTP.Modules.OpenApi;
+using GenHTTP.Modules.ApiBrowsing;
 
 using $safeprojectname$.Controllers;
 
@@ -17,6 +18,7 @@ public static IHandlerBuilder Setup()
         return Layout.Create()
                      .AddController<DeviceController>("devices")
                      .AddOpenApi()
+                     .AddSwaggerUI(segment: "docs")
                      .Add(CorsPolicy.Permissive());
     }
 

diff --git a/Templates/Webservice-Minimal/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj b/Templates/Webservice-Minimal/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj
@@ -19,7 +19,7 @@
 	<PackageReference Include="MSTest.TestAdapter" Version="3.6.4" />
 	<PackageReference Include="MSTest.TestFramework" Version="3.6.4" />
 
-    <PackageReference Include="GenHTTP.Testing" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Testing" Version="9.4.0" />
 
     <ProjectReference Include="..\$safeprojectname$\$safeprojectname$.csproj" />
 

diff --git a/Templates/Webservice-Minimal/$safeprojectname$/$safeprojectname$.csproj b/Templates/Webservice-Minimal/$safeprojectname$/$safeprojectname$.csproj
@@ -19,14 +19,12 @@
 
   <ItemGroup>
 
-    <PackageReference Include="GenHTTP.Core" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Core" Version="9.4.0" />
 
-    <PackageReference Include="GenHTTP.Modules.Security" Version="9.3.0" />
-    <PackageReference Include="GenHTTP.Modules.Functional" Version="9.3.0" />
-    <PackageReference Include="GenHTTP.Modules.OpenApi" Version="9.3.0" />
-
-	<!-- see https://github.com/dotnet/sdk/issues/42651 -->
-	<NuGetAuditSuppress Include="https://github.com/advisories/GHSA-5f2m-466j-3848;https://github.com/advisories/GHSA-x5qj-9vmx-7g6g;https://github.com/advisories/GHSA-xhfc-gr8f-ffwc" />
+    <PackageReference Include="GenHTTP.Modules.Security" Version="9.4.0" />
+    <PackageReference Include="GenHTTP.Modules.Functional" Version="9.4.0" />
+    <PackageReference Include="GenHTTP.Modules.OpenApi" Version="9.4.0" />
+    <PackageReference Include="GenHTTP.Modules.ApiBrowsing" Version="9.4.0" />
 
   </ItemGroup>
 

diff --git a/Templates/Webservice-Minimal/$safeprojectname$/Program.cs b/Templates/Webservice-Minimal/$safeprojectname$/Program.cs
@@ -4,6 +4,24 @@
 
 using $safeprojectname$;
 
+//
+// GenHTTP Functional Framework Template
+//
+// URLs:
+//   http://localhost:8080/devices/
+//   http://localhost:8080/docs/
+//   http://localhost:8080/openapi.json
+//
+// Framework documentation:
+//   https://genhttp.org/documentation/content/frameworks/functional/
+//
+// Method definitions:
+//   https://genhttp.org/documentation/content/concepts/definitions/
+//
+// Additional features:
+//   https://genhttp.org/documentation/content/
+//
+
 var project = Project.Setup();
 
 return await Host.Create()

diff --git a/Templates/Webservice-Minimal/$safeprojectname$/Project.cs b/Templates/Webservice-Minimal/$safeprojectname$/Project.cs
@@ -4,6 +4,7 @@
 using GenHTTP.Modules.Security;
 using GenHTTP.Modules.Functional;
 using GenHTTP.Modules.OpenApi;
+using GenHTTP.Modules.ApiBrowsing;
 
 namespace $safeprojectname$;
 
@@ -14,20 +15,19 @@ public static class Project
 
     public static IHandlerBuilder Setup()
     {
-        // run this project and fetch a list of book records via http://localhost:8080/books/
         var books = new List<Book>()
         {
             new Book(1, "Lord of the Rings")
         };
 
-        // see https://genhttp.org/documentation/content/frameworks/functional/
         var bookApi = Inline.Create()
                             .Get(() => books)
                             .Put((Book book) => books.Add(book));
 
         return Layout.Create()
                      .Add("books", bookApi)
                      .AddOpenApi()
+                     .AddSwaggerUI(segment: "docs")
                      .Add(CorsPolicy.Permissive());
     }
 

diff --git a/Templates/Webservice/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj b/Templates/Webservice/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj
@@ -19,7 +19,7 @@
     <PackageReference Include="MSTest.TestAdapter" Version="3.6.4" />
 	<PackageReference Include="MSTest.TestFramework" Version="3.6.4" />
 
-    <PackageReference Include="GenHTTP.Testing" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Testing" Version="9.4.0" />
 
     <ProjectReference Include="..\$safeprojectname$\$safeprojectname$.csproj" />
 

diff --git a/Templates/Webservice/$safeprojectname$/$safeprojectname$.csproj b/Templates/Webservice/$safeprojectname$/$safeprojectname$.csproj
@@ -19,14 +19,12 @@
 
   <ItemGroup>
 
-    <PackageReference Include="GenHTTP.Core" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Core" Version="9.4.0" />
 
-    <PackageReference Include="GenHTTP.Modules.Security" Version="9.3.0" />
-    <PackageReference Include="GenHTTP.Modules.Webservices" Version="9.3.0" />
-    <PackageReference Include="GenHTTP.Modules.OpenApi" Version="9.3.0" />
-
-	<!-- see https://github.com/dotnet/sdk/issues/42651 -->
-	<NuGetAuditSuppress Include="https://github.com/advisories/GHSA-5f2m-466j-3848;https://github.com/advisories/GHSA-x5qj-9vmx-7g6g;https://github.com/advisories/GHSA-xhfc-gr8f-ffwc" />
+    <PackageReference Include="GenHTTP.Modules.Security" Version="9.4.0" />
+    <PackageReference Include="GenHTTP.Modules.Webservices" Version="9.4.0" />
+    <PackageReference Include="GenHTTP.Modules.OpenApi" Version="9.4.0" />
+    <PackageReference Include="GenHTTP.Modules.ApiBrowsing" Version="9.4.0" />
 
   </ItemGroup>
 

diff --git a/Templates/Webservice/$safeprojectname$/Program.cs b/Templates/Webservice/$safeprojectname$/Program.cs
@@ -4,8 +4,23 @@
 
 using $safeprojectname$;
 
-// run this project and access the api at http://localhost:8080/books/
-// service specification at http://localhost:8080/openapi.json
+//
+// GenHTTP Webservice Framework Template
+//
+// URLs:
+//   http://localhost:8080/books/
+//   http://localhost:8080/docs/
+//   http://localhost:8080/openapi.json
+//
+// Framework documentation:
+//   https://genhttp.org/documentation/content/frameworks/webservices/
+//
+// Method definitions:
+//   https://genhttp.org/documentation/content/concepts/definitions/
+//
+// Additional features:
+//   https://genhttp.org/documentation/content/
+//
 
 var project = Project.Setup();
 

diff --git a/Templates/Webservice/$safeprojectname$/Project.cs b/Templates/Webservice/$safeprojectname$/Project.cs
@@ -1,9 +1,11 @@
-using GenHTTP.Api.Content;
+using System;
+using GenHTTP.Api.Content;
 
 using GenHTTP.Modules.Layouting;
 using GenHTTP.Modules.Security;
 using GenHTTP.Modules.Webservices;
 using GenHTTP.Modules.OpenApi;
+using GenHTTP.Modules.ApiBrowsing;
 
 using $safeprojectname$.Services;
 
@@ -17,6 +19,7 @@ public static IHandlerBuilder Setup()
         return Layout.Create()
                      .AddService<BookService>("books")
                      .AddOpenApi()
+                     .AddSwaggerUI(segment: "docs")
                      .Add(CorsPolicy.Permissive());
     }
 

diff --git a/Templates/Website-Static/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj b/Templates/Website-Static/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj
@@ -19,7 +19,7 @@
 	<PackageReference Include="MSTest.TestAdapter" Version="3.6.4" />
 	<PackageReference Include="MSTest.TestFramework" Version="3.6.4" />
 
-    <PackageReference Include="GenHTTP.Testing" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Testing" Version="9.4.0" />
 
     <ProjectReference Include="..\$safeprojectname$\$safeprojectname$.csproj" />
 

diff --git a/Templates/Website-Static/$safeprojectname$/$safeprojectname$.csproj b/Templates/Website-Static/$safeprojectname$/$safeprojectname$.csproj
@@ -27,12 +27,9 @@
 
   <ItemGroup>
 
-    <PackageReference Include="GenHTTP.Core" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Core" Version="9.4.0" />
 
-    <PackageReference Include="GenHTTP.Modules.StaticWebsites" Version="9.3.0" />
-
-	<!-- see https://github.com/dotnet/sdk/issues/42651 -->
-    <NuGetAuditSuppress Include="https://github.com/advisories/GHSA-5f2m-466j-3848;https://github.com/advisories/GHSA-x5qj-9vmx-7g6g;https://github.com/advisories/GHSA-xhfc-gr8f-ffwc" />
+    <PackageReference Include="GenHTTP.Modules.StaticWebsites" Version="9.4.0" />
 
   </ItemGroup>
 

diff --git a/Templates/Websocket/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj b/Templates/Websocket/$safeprojectname$.Tests/$safeprojectname$.Tests.csproj
@@ -19,7 +19,7 @@
 	<PackageReference Include="MSTest.TestAdapter" Version="3.6.4" />
 	<PackageReference Include="MSTest.TestFramework" Version="3.6.4" />
 
-    <PackageReference Include="GenHTTP.Testing" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Testing" Version="9.4.0" />
 
     <ProjectReference Include="..\$safeprojectname$\$safeprojectname$.csproj" />
 

diff --git a/Templates/Websocket/$safeprojectname$/$safeprojectname$.csproj b/Templates/Websocket/$safeprojectname$/$safeprojectname$.csproj
@@ -19,12 +19,9 @@
 
   <ItemGroup>
 
-    <PackageReference Include="GenHTTP.Core" Version="9.3.0" />
+    <PackageReference Include="GenHTTP.Core" Version="9.4.0" />
 
-    <PackageReference Include="GenHTTP.Modules.Websockets" Version="9.3.0" />
-
-	<!-- see https://github.com/dotnet/sdk/issues/42651 -->
-	<NuGetAuditSuppress Include="https://github.com/advisories/GHSA-5f2m-466j-3848;https://github.com/advisories/GHSA-x5qj-9vmx-7g6g;https://github.com/advisories/GHSA-xhfc-gr8f-ffwc" />
+    <PackageReference Include="GenHTTP.Modules.Websockets" Version="9.4.0" />
 
   </ItemGroup>