swagger docs

src/Hotline.Api/Controllers/BaseController.cs

@@ -3,6 +3,7 @@
 namespace Hotline.Api.Controllers;
 
 [ApiController]
+[Produces("application/json")]
 [Route("api/v1/[controller]")]
 public class BaseController : ControllerBase
 {

src/Hotline.Api/Controllers/OrderController.cs

@@ -17,6 +17,9 @@ using XF.Utility.EnumExtensions;
 
 namespace Hotline.Api.Controllers;
 
+/// <summary>
+/// 工单
+/// </summary>
 public class OrderController : BaseController
 {
     private readonly IOrderDomainService _orderDomainService;
@@ -105,6 +108,11 @@ public class OrderController : BaseController
         return _mapper.Map<OrderDto>(order);
     }
 
+    /// <summary>
+    /// 新增工单
+    /// </summary>
+    /// <param name="dto"></param>
+    /// <returns></returns>
     [HttpPost]
     public async Task<string> Add([FromBody] AddOrderDto dto)
     {
@@ -133,6 +141,12 @@ public class OrderController : BaseController
         await _orderRepository.UpdateAsync(order, HttpContext.RequestAborted);
     }
 
+    /// <summary>
+    /// 开始流程
+    /// </summary>
+    /// <param name="id">工单id</param>
+    /// <param name="dto">流程开启参数</param>
+    /// <returns></returns>
     [HttpPost("{id}/startflow")]
     public async Task StartFlow(string id, [FromBody] StartWorkflowDto dto)
     {
@@ -190,7 +204,7 @@ public class OrderController : BaseController
     }
 
     /// <summary>
-    /// 新增页面
+    /// 扩展信息新增页面
     /// </summary>
     /// <returns></returns>
     [HttpGet("base-data-ext")]

src/Hotline.Api/Hotline.Api.csproj

@@ -5,7 +5,7 @@
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
-    <DocumentationFile>document.xml</DocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
@@ -18,13 +18,11 @@
     <PackageReference Include="Microsoft.AspNetCore.SignalR.StackExchangeRedis" Version="6.0.8" />
     <PackageReference Include="Serilog.Sinks.Exceptionless" Version="3.1.5" />
     <PackageReference Include="Serilog.Sinks.MongoDB" Version="5.3.1" />
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.2.3" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\Hotline.Application\Hotline.Application.csproj" />
   </ItemGroup>
 
-  <ProjectExtensions><VisualStudio><UserProperties appsettings_1json__JsonSchema="" /></VisualStudio></ProjectExtensions>
-
 </Project>

src/Hotline.Api/StartupHelper.cs

@@ -1,4 +1,5 @@
 using System.IdentityModel.Tokens.Jwt;
+using System.Reflection;
 using System.Text;
 using Mapster;
 using MapsterMapper;
@@ -72,12 +73,12 @@ namespace Hotline.Api
                         {
                             var accessToken = context.Request.Query["access_token"];
 
-                                    // If the request is for our hub...
+                            // If the request is for our hub...
                             var path = context.HttpContext.Request.Path;
                             if (!string.IsNullOrEmpty(accessToken) &&
                                 (path.StartsWithSegments("/hubs/callcenter")))
                             {
-                                        // Read the token out of the query string
+                                // Read the token out of the query string
                                 context.Token = accessToken;
                             }
                             return Task.CompletedTask;
@@ -100,12 +101,11 @@ namespace Hotline.Api
             {
                 //添加文档
                 c.SwaggerDoc("v1", new OpenApiInfo() { Title = "Hotline Api", Version = "v1.0", Description = "城市热线api" });
-                //使用反射获取xml文件，并构造出文件的路径
-                var xmlFile = "document.xml";
-                //var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
-                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
-                // 启用xml注释. 该方法第二个参数启用控制器的注释，默认为false.
-                c.IncludeXmlComments(xmlPath, true);
+                var files = Directory.GetFiles(AppContext.BaseDirectory).Where(d => d.EndsWith(".xml"));
+                foreach (var file in files)
+                {
+                    c.IncludeXmlComments(file, true);
+                }
 
                 var scheme = new OpenApiSecurityScheme()
                 {

src/Hotline.Share/Dtos/FlowEngine/StartWorkflowDto.cs

@@ -2,8 +2,15 @@
 {
     public class StartWorkflowDto : BasicWorkflowDto
     {
+        /// <summary>
+        /// 模板编码
+        /// </summary>
         public string DefinitionCode { get; set; }
 
+        /// <summary>
+        /// 流程title
+        /// </summary>
+
         public string Title { get; set; }
     }
 }

src/Hotline.Share/Dtos/Order/OrderDto.cs

@@ -228,7 +228,14 @@ namespace Hotline.Share.Dtos.Order
 
         #endregion
 
+        /// <summary>
+        /// 投诉
+        /// </summary>
         public OrderComplainDto OrderComplain { get; set; }
+
+        /// <summary>
+        /// 举报
+        /// </summary>
         public OrderReportDto OrderReport { get; set; }
     }
 }

src/Hotline.Share/Hotline.Share.csproj

@@ -4,6 +4,8 @@
     <TargetFramework>net6.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>