浏览代码

新增接口文档访问地址

zhontai 2 年之前
父节点
当前提交
847074cf67

+ 1 - 1
build/pkg.props

@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
-    <Version>2.2.2</Version>
+    <Version>2.2.21</Version>
 	<TargetFramework>net6.0</TargetFramework>
 	<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
 	<GenerateDocumentationFile>true</GenerateDocumentationFile>

+ 2 - 0
src/hosts/ZhonTai.Host/Configs/appconfig.json

@@ -22,6 +22,7 @@
   "swagger": {
     //启用
     "enable": true,
+    "routePrefix": "swagger",
     //地址
     "url": "http://localhost:8000",
     "projects": [
@@ -37,6 +38,7 @@
   "apiUI": {
     //启用
     "enable": true,
+    "routePrefix": "",
     //页脚
     "footer": {
       "enable": true,

+ 1 - 1
src/hosts/ZhonTai.Host/Program.cs

@@ -48,7 +48,7 @@ new HostApp(new HostAppOptions
 		{
 			app.UseApiUI(options =>
 			{
-				options.RoutePrefix = "";
+				options.RoutePrefix = appConfig.ApiUI.RoutePrefix;
 				appConfig.Swagger.Projects?.ForEach(project =>
 				{
 					options.SwaggerEndpoint($"/swagger/{project.Code.ToLower()}/swagger.json", project.Name);

+ 0 - 1
src/platform/ZhonTai.Admin/Core/Attributes/TransactionAttribute.cs

@@ -1,7 +1,6 @@
 using FreeSql;
 using System;
 using System.Data;
-using ZhonTai.Admin.Core.Consts;
 
 namespace ZhonTai.Admin.Core.Attributes;
 

+ 10 - 0
src/platform/ZhonTai.Admin/Core/Configs/AppConfig.cs

@@ -95,6 +95,11 @@ public class SwaggerConfig
     /// </summary>
     public bool Enable { get; set; } = false;
 
+    /// <summary>
+    /// 访问地址
+    /// </summary>
+    public string RoutePrefix { get; set; } = "swagger";
+
     /// <summary>
     /// 地址
     /// </summary>
@@ -116,6 +121,11 @@ public class ApiUIConfig
     /// </summary>
     public bool Enable { get; set; } = false;
 
+    /// <summary>
+    /// 访问地址
+    /// </summary>
+    public string RoutePrefix { get; set; } = "";
+
     public SwaggerFooterConfig Footer { get; set; } = new SwaggerFooterConfig();
 }
 

+ 1 - 1
src/platform/ZhonTai.Admin/Core/HostApp.cs

@@ -604,7 +604,7 @@ public class HostApp
                     c.SwaggerEndpoint($"/swagger/{project.Code.ToLower()}/swagger.json", project.Name);
                 });
 
-                c.RoutePrefix = "swagger";//直接根目录访问,如果是IIS发布可以注释该语句,并打开launchSettings.launchUrl
+                c.RoutePrefix = appConfig.Swagger.RoutePrefix; ;//直接根目录访问,如果是IIS发布可以注释该语句,并打开launchSettings.launchUrl
                 c.DocExpansion(Swashbuckle.AspNetCore.SwaggerUI.DocExpansion.None);//折叠Api
                 //c.DefaultModelsExpandDepth(-1);//不显示Models
                 if (appConfig.MiniProfiler)

+ 0 - 1
src/platform/ZhonTai.Admin/Services/User/UserService.cs

@@ -6,7 +6,6 @@ using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Options;
 using ZhonTai.Admin.Core.Attributes;
 using ZhonTai.Admin.Core.Configs;
-using ZhonTai.Admin.Core.Repositories;
 using ZhonTai.Common.Helpers;
 using ZhonTai.Admin.Core.Dto;
 using ZhonTai.Admin.Domain.Api;

+ 10 - 0
src/platform/ZhonTai.Admin/ZhonTai.Admin.xml

@@ -356,6 +356,11 @@
             启用
             </summary>
         </member>
+        <member name="P:ZhonTai.Admin.Core.Configs.SwaggerConfig.RoutePrefix">
+            <summary>
+            访问地址
+            </summary>
+        </member>
         <member name="P:ZhonTai.Admin.Core.Configs.SwaggerConfig.Url">
             <summary>
             地址
@@ -376,6 +381,11 @@
             启用
             </summary>
         </member>
+        <member name="P:ZhonTai.Admin.Core.Configs.ApiUIConfig.RoutePrefix">
+            <summary>
+            访问地址
+            </summary>
+        </member>
         <member name="T:ZhonTai.Admin.Core.Configs.SwaggerFooterConfig">
             <summary>
             Swagger页脚配置