feat: add samples

liuweichaox · liuweichaox · commit dc28b7990b3a · 2025-02-18T09:57:33.000+08:00
diff --git a/Samples/Controllers/OrderController.cs b/Samples/Controllers/OrderController.cs
@@ -1,7 +1,7 @@
 ﻿using Microsoft.AspNetCore.Mvc;
-using Sample.Models;
+using Samples.Models;
 
-namespace Sample.Controllers
+namespace Samples.Controllers
 {
     /// <summary>
     /// 示例控制器
diff --git a/Samples/Models/Address.cs b/Samples/Models/Address.cs
@@ -1,6 +1,6 @@
 using System.ComponentModel.DataAnnotations;
 
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 地址
diff --git a/Samples/Models/CreateOrderRequest.cs b/Samples/Models/CreateOrderRequest.cs
@@ -1,6 +1,6 @@
 using System.ComponentModel.DataAnnotations;
 
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 创建订单参数
diff --git a/Samples/Models/CreateOrderResponse.cs b/Samples/Models/CreateOrderResponse.cs
@@ -1,6 +1,6 @@
 using System.ComponentModel.DataAnnotations;
 
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 创建订单返回
diff --git a/Samples/Models/DeleteOrderResponse.cs b/Samples/Models/DeleteOrderResponse.cs
@@ -1,4 +1,4 @@
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 删除订单返回
diff --git a/Samples/Models/GetOrderListRequest.cs b/Samples/Models/GetOrderListRequest.cs
@@ -1,6 +1,6 @@
 using System.ComponentModel.DataAnnotations;
 
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 查询订单详情参数
diff --git a/Samples/Models/GetOrderListResponse.cs b/Samples/Models/GetOrderListResponse.cs
@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 订单列表返回
diff --git a/Samples/Models/Order.cs b/Samples/Models/Order.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 订单
diff --git a/Samples/Models/OrderStatus.cs b/Samples/Models/OrderStatus.cs
@@ -1,6 +1,6 @@
 using System.ComponentModel;
 
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 订单状态
diff --git a/Samples/Models/OrderType.cs b/Samples/Models/OrderType.cs
@@ -1,6 +1,6 @@
 using System.ComponentModel;
 
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 订单类型
diff --git a/Samples/Models/UpdateOrderRequest.cs b/Samples/Models/UpdateOrderRequest.cs
@@ -1,6 +1,6 @@
 using System.ComponentModel.DataAnnotations;
 
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 更新订单
diff --git a/Samples/Models/UpdateOrderResponse.cs b/Samples/Models/UpdateOrderResponse.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Sample.Models;
+namespace Samples.Models;
 
 /// <summary>
 /// 更新订单返回
diff --git a/Samples/Program.cs b/Samples/Program.cs
@@ -12,14 +12,34 @@
 builder.Services.AddEndpointsApiExplorer();
 builder.Services.AddSwaggerGen(c =>
 {
-    c.SwaggerDoc("v1", new OpenApiInfo {Title = "Swagger API 文档", Version = "v1", Description = "API 文档"});
+    c.SwaggerDoc("v1", new OpenApiInfo
+    {
+        Title = "Swagger API 文档", 
+        Version = "v1", 
+        Description = "API 文档"
+    });
+    
     // 添加枚举过滤器，在文档中显示枚举的描述信息
     c.DocumentFilter<SwaggerEnumFilter>(new object[]
     {
         // 枚举所在的程序集
-        new[] {Assembly.GetExecutingAssembly()}
+        new[] { Assembly.GetExecutingAssembly() }
     });
-    c.IncludeXmlComments("Samples.xml");
+    
+    //  注入多个程序集的 XML 注释
+    var xmlPaths = new List<string>()
+    {
+        "Samples.xml"
+    };
+
+    foreach (var xmlPath in xmlPaths)
+    {
+        var xmlFullPath = Path.Combine(AppContext.BaseDirectory, xmlPath);
+        if (File.Exists(xmlFullPath))
+        {
+            c.IncludeXmlComments(xmlFullPath);
+        }
+    }
 });
 builder.Services.AddSwaggerDoc();
 
@@ -31,6 +51,7 @@
     app.UseSwagger();
     app.UseSwaggerUI();
 }
+
 app.UseAuthorization();
 
 app.MapControllers();
diff --git a/Samples/Properties/launchSettings.json b/Samples/Properties/launchSettings.json
diff --git a/Samples/Samples.csproj b/Samples/Samples.csproj
@@ -21,6 +21,7 @@
     </ItemGroup>
 
     <ItemGroup>
+      <ProjectReference Include="..\ClassLibrary1\ClassLibrary1.csproj" />
       <ProjectReference Include="..\SwaggerDoc\SwaggerDoc.csproj" />
     </ItemGroup>
 
diff --git a/Samples/Samples.xml b/Samples/Samples.xml
diff --git a/Samples/appsettings.Development.json b/Samples/appsettings.Development.json
diff --git a/Samples/appsettings.json b/Samples/appsettings.json
diff --git a/SawaggerDocGen.sln b/SawaggerDocGen.sln
diff --git a/SwaggerDoc/SwaggerDoc.csproj b/SwaggerDoc/SwaggerDoc.csproj

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`using Microsoft.AspNetCore.Mvc;`
`2`		`-using Sample.Models;`
	`2`	`+using Samples.Models;`
`3`	`3`
`4`		`-namespace Sample.Controllers`
	`4`	`+namespace Samples.Controllers`
`5`	`5`	`{`
`6`	`6`	`/// <summary>`
`7`	`7`	`/// 示例控制器`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace Sample.Models;`
	`1`	`+namespace Samples.Models;`
`2`	`2`
`3`	`3`	`/// <summary>`
`4`	`4`	`/// 删除订单返回`