Merge pull request #238 from abpframework/gterdem/swagger_fix

eShopOnAbp: Keycloak swagger authorization
abpframework · Feb 22, 2024 · acc8a1c · acc8a1c
2 parents b09a23e + 8e14075
commit acc8a1c
Show file tree

Hide file tree

Showing 21 changed files with 79 additions and 28 deletions.
diff --git a/gateways/web-public/src/EShopOnAbp.WebPublicGateway/appsettings.json b/gateways/web-public/src/EShopOnAbp.WebPublicGateway/appsettings.json
@@ -7,7 +7,7 @@
   "AuthServer": {
     "Authority": "http://localhost:8080/realms/master",
     "RequireHttpsMetadata": "true",
-    "SwaggerClientId": "WebGateway_Swagger",
+    "SwaggerClientId": "SwaggerClient",
     "SwaggerClientSecret": "1q2w3e*"
   },
   "Logging": {

diff --git a/gateways/web/src/EShopOnAbp.WebGateway/appsettings.json b/gateways/web/src/EShopOnAbp.WebGateway/appsettings.json
@@ -8,7 +8,7 @@
     "Authority": "http://localhost:8080/realms/master",
     "RequireHttpsMetadata": "true",
     "MetadataAddress": "http://localhost:8080/realms/master",
-    "SwaggerClientId": "WebGateway_Swagger"
+    "SwaggerClientId": "SwaggerClient"
   },
   "Logging": {
     "LogLevel": {

diff --git a/...c/EShopOnAbp.AdministrationService.HttpApi.Host/AdministrationServiceHttpApiHostModule.cs b/...c/EShopOnAbp.AdministrationService.HttpApi.Host/AdministrationServiceHttpApiHostModule.cs
@@ -59,17 +59,11 @@ public override void ConfigureServices(ServiceConfigurationContext context)
                     .AllowCredentials();
             });
         });
-
-        Configure<PermissionManagementOptions>(options =>
-        {
-            options.IsDynamicPermissionStoreEnabled = true;
-        });
 
-        Configure<SettingManagementOptions>(options =>
-        {
-            options.IsDynamicSettingStoreEnabled = true;
-        });
-
+        Configure<PermissionManagementOptions>(options => { options.IsDynamicPermissionStoreEnabled = true; });
+
+        Configure<SettingManagementOptions>(options => { options.IsDynamicSettingStoreEnabled = true; });
+
         // Configure<AbpPermissionOptions>(options =>
         // {
         //     options.ValueProviders.Clear();
@@ -99,7 +93,7 @@ public override void OnApplicationInitialization(ApplicationInitializationContex
         app.UseUnitOfWork();
         app.UseAuthorization();
         app.UseSwagger();
-        app.UseAbpSwaggerUI(options =>
+        app.UseAbpSwaggerWithCustomScriptUI(options =>
         {
             var configuration = context.ServiceProvider.GetRequiredService<IConfiguration>();
             options.SwaggerEndpoint("/swagger/v1/swagger.json", "Administration Service API");

diff --git a/services/basket/src/EShopOnAbp.BasketService/BasketServiceModule.cs b/services/basket/src/EShopOnAbp.BasketService/BasketServiceModule.cs
@@ -95,7 +95,7 @@ public override void OnApplicationInitialization(ApplicationInitializationContex
         app.UseAbpClaimsMap();
         app.UseAuthorization();
         app.UseSwagger();
-        app.UseAbpSwaggerUI(options =>
+        app.UseAbpSwaggerWithCustomScriptUI(options =>
         {
             var configuration = context.ServiceProvider.GetRequiredService<IConfiguration>();
             options.SwaggerEndpoint("/swagger/v1/swagger.json", "Basket Service API");

diff --git a/services/basket/src/EShopOnAbp.BasketService/appsettings.json b/services/basket/src/EShopOnAbp.BasketService/appsettings.json
@@ -7,7 +7,7 @@
     "Authority": "http://localhost:8080/realms/master",
     "RequireHttpsMetadata": "false",
     "MetadataAddress": "http://localhost:8080/realms/master",
-    "SwaggerClientId": "WebGateway_Swagger"
+    "SwaggerClientId": "SwaggerClient"
   },
   "RemoteServices": {
     "Catalog": {

diff --git a/...ces/catalog/src/EShopOnAbp.CatalogService.HttpApi.Host/CatalogServiceHttpApiHostModule.cs b/...ces/catalog/src/EShopOnAbp.CatalogService.HttpApi.Host/CatalogServiceHttpApiHostModule.cs
@@ -101,7 +101,7 @@ public override void OnApplicationInitialization(ApplicationInitializationContex
         app.UseAbpClaimsMap();
         app.UseAuthorization();
         app.UseSwagger();
-        app.UseAbpSwaggerUI(options =>
+        app.UseAbpSwaggerWithCustomScriptUI(options =>
         {
             var configuration = context.ServiceProvider.GetRequiredService<IConfiguration>();
             options.SwaggerEndpoint("/swagger/v1/swagger.json", "Catalog Service API");

diff --git a/services/catalog/src/EShopOnAbp.CatalogService.HttpApi.Host/appsettings.json b/services/catalog/src/EShopOnAbp.CatalogService.HttpApi.Host/appsettings.json
@@ -7,7 +7,7 @@
     "Authority": "http://localhost:8080/realms/master",
     "RequireHttpsMetadata": "false",
     "MetadataAddress": "http://localhost:8080/realms/master",
-    "SwaggerClientId": "WebGateway_Swagger"
+    "SwaggerClientId": "SwaggerClient"
   },
   "Logging": {
     "LogLevel": {

diff --git a/services/cmskit/src/EShopOnAbp.CmskitService.HttpApi.Host/CmskitServiceHttpApiHostModule.cs b/services/cmskit/src/EShopOnAbp.CmskitService.HttpApi.Host/CmskitServiceHttpApiHostModule.cs
@@ -111,7 +111,7 @@ public override void OnApplicationInitialization(ApplicationInitializationContex
         app.UseAbpClaimsMap();
         app.UseAuthorization();
         app.UseSwagger();
-        app.UseAbpSwaggerUI(options =>
+        app.UseAbpSwaggerWithCustomScriptUI(options =>
         {
             var configuration = context.ServiceProvider.GetRequiredService<IConfiguration>();
             options.SwaggerEndpoint("/swagger/v1/swagger.json", "Cmskit Service API");

diff --git a/services/cmskit/src/EShopOnAbp.CmskitService.HttpApi.Host/appsettings.json b/services/cmskit/src/EShopOnAbp.CmskitService.HttpApi.Host/appsettings.json
@@ -7,7 +7,7 @@
     "Authority": "http://localhost:8080/realms/master",
     "RequireHttpsMetadata": "false",
     "MetadataAddress": "http://localhost:8080/realms/master",
-    "SwaggerClientId": "WebGateway_Swagger"
+    "SwaggerClientId": "SwaggerClient"
   },
   "Logging": {
     "LogLevel": {

diff --git a/...rc/EShopOnAbp.IdentityService.HttpApi.Host/EShopOnAbp.IdentityService.HttpApi.Host.csproj b/...rc/EShopOnAbp.IdentityService.HttpApi.Host/EShopOnAbp.IdentityService.HttpApi.Host.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
     <RootNamespace>EShopOnAbp.IdentityService</RootNamespace>
+    <PreserveCompilationReferences>true</PreserveCompilationReferences>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/.../identity/src/EShopOnAbp.IdentityService.HttpApi.Host/IdentityServiceHttpApiHostModule.cs b/.../identity/src/EShopOnAbp.IdentityService.HttpApi.Host/IdentityServiceHttpApiHostModule.cs
@@ -22,8 +22,7 @@ namespace EShopOnAbp.IdentityService;
     typeof(EShopOnAbpSharedHostingMicroservicesModule),
     typeof(IdentityServiceHttpApiModule),
     typeof(IdentityServiceApplicationModule),
-    typeof(IdentityServiceEntityFrameworkCoreModule),
-    typeof(EShopOnAbpSharedHostingGatewaysModule)
+    typeof(IdentityServiceEntityFrameworkCoreModule)
 )]
 public class IdentityServiceHttpApiHostModule : AbpModule
 {
@@ -91,7 +90,7 @@ public override void OnApplicationInitialization(ApplicationInitializationContex
         app.UseAbpClaimsMap();
         app.UseAuthorization();
         app.UseSwagger();
-        app.UseAbpSwaggerUI(options =>
+        app.UseAbpSwaggerWithCustomScriptUI(options =>
         {
             var configuration = context.ServiceProvider.GetRequiredService<IConfiguration>();
             options.SwaggerEndpoint("/swagger/v1/swagger.json", "Identity Service API");

diff --git a/services/identity/src/EShopOnAbp.IdentityService.HttpApi.Host/appsettings.json b/services/identity/src/EShopOnAbp.IdentityService.HttpApi.Host/appsettings.json
@@ -7,7 +7,7 @@
     "Authority": "http://localhost:8080/realms/master",
     "RequireHttpsMetadata": "false",
     "MetadataAddress": "http://localhost:8080/realms/master",
-    "SwaggerClientId": "WebGateway_Swagger"
+    "SwaggerClientId": "SwaggerClient"
   },
   "Keycloak": {
     "url": "http://localhost:8080",

diff --git a/.../ordering/src/EShopOnAbp.OrderingService.HttpApi.Host/OrderingServiceHttpApiHostModule.cs b/.../ordering/src/EShopOnAbp.OrderingService.HttpApi.Host/OrderingServiceHttpApiHostModule.cs
@@ -88,7 +88,7 @@ public override void OnApplicationInitialization(ApplicationInitializationContex
         app.UseAbpClaimsMap();
         app.UseAuthorization();
         app.UseSwagger();
-        app.UseAbpSwaggerUI(options =>
+        app.UseAbpSwaggerWithCustomScriptUI(options =>
         {
             var configuration = context.ServiceProvider.GetRequiredService<IConfiguration>();
             options.SwaggerEndpoint("/swagger/v1/swagger.json", "Ordering Service API");

diff --git a/services/ordering/src/EShopOnAbp.OrderingService.HttpApi.Host/appsettings.json b/services/ordering/src/EShopOnAbp.OrderingService.HttpApi.Host/appsettings.json
@@ -7,7 +7,7 @@
     "Authority": "http://localhost:8080/realms/master",
     "RequireHttpsMetadata": "false",
     "MetadataAddress": "http://localhost:8080/realms/master",
-    "SwaggerClientId": "WebGateway_Swagger"
+    "SwaggerClientId": "SwaggerClient"
   },
   "Logging": {
     "LogLevel": {

diff --git a/...ces/payment/src/EShopOnAbp.PaymentService.HttpApi.Host/PaymentServiceHttpApiHostModule.cs b/...ces/payment/src/EShopOnAbp.PaymentService.HttpApi.Host/PaymentServiceHttpApiHostModule.cs
@@ -81,7 +81,7 @@ public override void OnApplicationInitialization(ApplicationInitializationContex
         app.UseAbpClaimsMap();
         app.UseAuthorization();
         app.UseSwagger();
-        app.UseAbpSwaggerUI(options =>
+        app.UseAbpSwaggerWithCustomScriptUI(options =>
         {
             var configuration = context.ServiceProvider.GetRequiredService<IConfiguration>();
             options.SwaggerEndpoint("/swagger/v1/swagger.json", "Payment Service API");

diff --git a/services/payment/src/EShopOnAbp.PaymentService.HttpApi.Host/appsettings.json b/services/payment/src/EShopOnAbp.PaymentService.HttpApi.Host/appsettings.json
@@ -7,7 +7,7 @@
     "Authority": "http://localhost:8080/realms/master",
     "RequireHttpsMetadata": "false",
     "MetadataAddress": "http://localhost:8080/realms/master",
-    "SwaggerClientId": "WebGateway_Swagger"
+    "SwaggerClientId": "SwaggerClient"
   },
   "Logging": {
     "LogLevel": {

diff --git a/shared/EShopOnAbp.Shared.Hosting.AspNetCore/AbpSwaggerUIBuilderExtensions.cs b/shared/EShopOnAbp.Shared.Hosting.AspNetCore/AbpSwaggerUIBuilderExtensions.cs
@@ -0,0 +1,27 @@
+using System;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.Extensions.DependencyInjection;
+using Swashbuckle.AspNetCore.SwaggerUI;
+using Volo.Abp.Swashbuckle;
+
+namespace EShopOnAbp.Shared.Hosting.AspNetCore;
+
+public static class AbpSwaggerUIBuilderExtensions
+{
+    public static IApplicationBuilder UseAbpSwaggerWithCustomScriptUI(
+        this IApplicationBuilder app,
+        Action<SwaggerUIOptions>? setupAction = null)
+    {
+        var resolver = app.ApplicationServices.GetService<ISwaggerHtmlResolver>();
+
+        return app.UseSwaggerUI(options =>
+        {
+            options.InjectJavascript("ui/abp.js");
+            options.InjectJavascript("ui/abp.swagger.js");
+            options.InjectJavascript("ui/requestinterceptor.js");
+            options.IndexStream = () => resolver?.Resolver();
+
+            setupAction?.Invoke(options);
+        });
+    }
+}
diff --git a/shared/EShopOnAbp.Shared.Hosting.AspNetCore/EShopOnAbp.Shared.Hosting.AspNetCore.csproj b/shared/EShopOnAbp.Shared.Hosting.AspNetCore/EShopOnAbp.Shared.Hosting.AspNetCore.csproj
@@ -17,4 +17,19 @@
         <ProjectReference Include="..\EShopOnAbp.Shared.Localization\EShopOnAbp.Shared.Localization.csproj" />
     </ItemGroup>
 
+    <ItemGroup>
+        <None Remove="wwwroot\swagger\ui\requestinterceptor.js" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <Content Include="wwwroot\swagger\ui\requestinterceptor.js">
+        <ExcludeFromSingleFile>true</ExcludeFromSingleFile>
+        <CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
+      </Content>
+    </ItemGroup>
+
+    <ItemGroup>
+      <EmbeddedResource Include="wwwroot\swagger\ui\requestinterceptor.js" />
+    </ItemGroup>
+
 </Project>
diff --git a/shared/EShopOnAbp.Shared.Hosting.AspNetCore/EShopOnAbpSharedHostingAspNetCoreModule.cs b/shared/EShopOnAbp.Shared.Hosting.AspNetCore/EShopOnAbpSharedHostingAspNetCoreModule.cs
@@ -1,6 +1,7 @@
 using Volo.Abp.AspNetCore.Serilog;
 using Volo.Abp.Modularity;
 using Volo.Abp.Swashbuckle;
+using Volo.Abp.VirtualFileSystem;
 
 namespace EShopOnAbp.Shared.Hosting.AspNetCore;
 
@@ -14,5 +15,9 @@ public class EShopOnAbpSharedHostingAspNetCoreModule : AbpModule
 {
     public override void ConfigureServices(ServiceConfigurationContext context)
     {
+        Configure<AbpVirtualFileSystemOptions>(options =>
+        {
+            options.FileSets.AddEmbedded<EShopOnAbpSharedHostingAspNetCoreModule>("EShopOnAbp.Shared.Hosting.AspNetCore");
+        });
     }
 }
diff --git a/shared/EShopOnAbp.Shared.Hosting.AspNetCore/wwwroot/swagger/ui/requestinterceptor.js b/shared/EShopOnAbp.Shared.Hosting.AspNetCore/wwwroot/swagger/ui/requestinterceptor.js
@@ -0,0 +1,9 @@
+const originalFetch = window.fetch;
+
+window.fetch = function (input, init) {
+    if (init !== undefined && init.headers['RequestVerificationToken'] !== undefined) {
+        delete init.headers['RequestVerificationToken'];
+    }
+
+    return originalFetch.apply(this, arguments);
+};
diff --git a/shared/EShopOnAbp.Shared.Hosting.Gateways/YarpSwaggerUIBuilderExtensions.cs b/shared/EShopOnAbp.Shared.Hosting.Gateways/YarpSwaggerUIBuilderExtensions.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Linq;
+using EShopOnAbp.Shared.Hosting.AspNetCore;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
@@ -15,7 +16,7 @@ public static IApplicationBuilder UseSwaggerUIWithYarp(this IApplicationBuilder
         ApplicationInitializationContext context)
     {
         app.UseSwagger();
-        app.UseAbpSwaggerUI(options =>
+        app.UseAbpSwaggerWithCustomScriptUI(options =>
         {
             var configuration = context.ServiceProvider.GetRequiredService<IConfiguration>();
             var logger = context.ServiceProvider.GetRequiredService<ILogger<ApplicationInitializationContext>>();