Merge pull request #7 from lohaaa/net8

liuweichaox · web-flow · commit 7580e6337dcc · 2025-01-06T19:07:17.000+08:00
diff --git a/Sample/Models/CreateOrderRequest.cs b/Sample/Models/CreateOrderRequest.cs
@@ -10,19 +10,21 @@ public class CreateOrderRequest
     /// <summary>
     /// 商品ID
     /// </summary>
+    [Range(1, int.MaxValue, ErrorMessage = "范围为1-int32.max")]
     public int GoodsId { get; set; }
-    
+
     /// <summary>
     /// 商品名称
     /// </summary>
     [Required]
+    [MaxLength(256, ErrorMessage = "最大长度为256")]
     public string GoodsName { get; set; }
-    
+
     /// <summary>
     /// 商品数量
     /// </summary>
     public int GoodsNum { get; set; }
-    
+
     /// <summary>
     /// 订单类型
     /// </summary>
diff --git a/Sample/Models/CreateOrderResponse.cs b/Sample/Models/CreateOrderResponse.cs
@@ -1,3 +1,5 @@
+using System.ComponentModel.DataAnnotations;
+
 namespace Sample.Models;
 
 /// <summary>
@@ -8,13 +10,16 @@ public class CreateOrderResponse
     /// <summary>
     /// 订单号
     /// </summary>
+    [MinLength(1, ErrorMessage = "最小长度为1")]
+    [MaxLength(64, ErrorMessage = "最大长度为64")]
+    [RegularExpression("^[a-zA-Z0-9-]+$", ErrorMessage = "只允许包含大小写字母、数字和英文中横线")]
     public string OrderNo { get; set; }
 
     /// <summary>
     /// 支付链接
     /// </summary>
     public string PayUrl { get; set; }
-    
+
     /// <summary>
     /// 支付二维码
     /// </summary>
diff --git a/Sample/Models/GetOrderListRequest.cs b/Sample/Models/GetOrderListRequest.cs
@@ -1,3 +1,5 @@
+using System.ComponentModel.DataAnnotations;
+
 namespace Sample.Models;
 
 /// <summary>
@@ -8,13 +10,16 @@ public class GetOrderListRequest
     /// <summary>
     /// 订单号
     /// </summary>
+    [MinLength(1, ErrorMessage = "最小长度为1")]
+    [MaxLength(64, ErrorMessage = "最大长度为64")]
+    [RegularExpression("^[a-zA-Z0-9-]+$", ErrorMessage = "只允许包含大小写字母、数字和英文中横线")]
     public string OrderNo { get; set; }
-    
+
     /// <summary>
     /// 订单类型
     /// </summary>
     public OrderType OrderType { get; set; }
-    
+
     /// <summary>
     /// 订单状态
     /// </summary>
diff --git a/SwaggerDoc/Models/OtherInfo.cs b/SwaggerDoc/Models/OtherInfo.cs
@@ -0,0 +1,36 @@
+﻿using System.Text.Json.Serialization;
+
+namespace SwaggerDoc.Models
+{
+    /// <summary>
+    /// 其他信息
+    /// </summary>
+    public class OtherInfo
+    {
+        /// <summary>
+        /// 最小长度
+        /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        public int? 最小长度 { get; set; }
+        /// <summary>
+        /// 最大长度
+        /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        public int? 最大长度 { get; set; }
+        /// <summary>
+        /// 最小值
+        /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        public decimal? 最小值 { get; set; }
+        /// <summary>
+        /// 最大值
+        /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        public decimal? 最大值 { get; set; }
+        /// <summary>
+        /// 格式校验
+        /// </summary>
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        public string 格式校验 { get; set; }
+    }
+}
diff --git a/SwaggerDoc/Models/RequestModelInfo.cs b/SwaggerDoc/Models/RequestModelInfo.cs
@@ -24,5 +24,10 @@ public class RequestModelInfo
         /// 是否必传
         /// </summary>
         public bool 是否必传 { get; set; }
+
+        /// <summary>
+        /// 其他信息
+        /// </summary>
+        public OtherInfo 其他信息 { get; set; }
     }
 }
diff --git a/SwaggerDoc/Models/ResponseModelInfo.cs b/SwaggerDoc/Models/ResponseModelInfo.cs
@@ -19,5 +19,10 @@ public class ResponseModelInfo
         /// 可空类型
         /// </summary>
         public bool 可空类型 { get; set; }
+
+        /// <summary>
+        /// 其他信息
+        /// </summary>
+        public OtherInfo 其他信息 { get; set; }
     }
 }
diff --git a/SwaggerDoc/SwaggerDocGenerator.cs b/SwaggerDoc/SwaggerDocGenerator.cs
@@ -135,12 +135,12 @@ private string GetParameters(IEnumerable<OpenApiParameter> apiParameters)
         {
             string str = null;
             var isFirst = true;
-            var queryTitle = "|参数名称|参数类型|参数位置|描述|".NewLine();
-            queryTitle += "|:----:|:----:|:----:|:----:|".NewLine();
+            var queryTitle = "|参数名称|参数类型|参数位置|描述|其他信息|".NewLine();
+            queryTitle += "|:----:|:----:|:----:|:----:|:----:|".NewLine();
             foreach (var parameter in apiParameters)
             {
                 var queryStr =
-                    $"|{parameter.Name}|{parameter.Schema.Type ?? parameter.Schema.Reference.Id}|{parameter.In}|{parameter.Description}|"
+                    $"|{parameter.Name}|{parameter.Schema.Type ?? parameter.Schema.Reference.Id}|{parameter.In}|{parameter.Description}|{GetParameterOtherInfo(parameter)}|"
                         .NewLine();
                 str += isFirst ? $"{queryTitle}{queryStr}" : queryStr;
                 isFirst = false;
@@ -149,6 +149,23 @@ private string GetParameters(IEnumerable<OpenApiParameter> apiParameters)
             return str;
         }
 
+        /// <summary>
+        /// 获取参数其他信息
+        /// </summary>
+        /// <param name="parameter">参数</param>
+        /// <returns>参数其他信息</returns>
+        private static string GetParameterOtherInfo(OpenApiParameter parameter)
+        {
+            var otherInfoStr = string.Empty;
+            otherInfoStr += parameter.Required ? $"是否必传：`{parameter.Required.ToString()}`".Br() : string.Empty;
+            otherInfoStr += parameter.Schema.MinLength.HasValue ? $"最小长度：`{parameter.Schema.MinLength.Value}`".Br() : string.Empty;
+            otherInfoStr += parameter.Schema.MaxLength.HasValue ? $"最大长度：`{parameter.Schema.MaxLength.Value}`".Br() : string.Empty;
+            otherInfoStr += parameter.Schema.Minimum.HasValue ? $"最小值：`{parameter.Schema.Minimum.Value}`".Br() : string.Empty;
+            otherInfoStr += parameter.Schema.Maximum.HasValue ? $"最大值：`{parameter.Schema.Maximum.Value}`".Br() : string.Empty;
+            otherInfoStr += !string.IsNullOrWhiteSpace(parameter.Schema.Pattern) ? $"格式校验：`{parameter.Schema.Pattern}`" : string.Empty;
+            return otherInfoStr;
+        }
+
         /// <summary>
         /// 获取 RequestBody 参数说明、JSON 示例
         /// </summary>
@@ -388,7 +405,15 @@ private object GetFiledDetails(string key, ModelType modelType)
                         参数类型 = obj,
                         描述 = value.Description,
                         是否必传 = schema.Required.Any(x => x == s),
-                        可空类型 = value.Nullable
+                        可空类型 = value.Nullable,
+                        其他信息 = new OtherInfo
+                        {
+                            最小长度 = value.MinLength,
+                            最大长度 = value.MaxLength,
+                            格式校验 = value.Pattern,
+                            最小值 = value.Minimum,
+                            最大值 = value.Maximum,
+                        }
                     };
                     properties.Add(s, requestModelInfo);
                 }
@@ -398,7 +423,15 @@ private object GetFiledDetails(string key, ModelType modelType)
                     {
                         参数类型 = obj,
                         描述 = value.Description,
-                        可空类型 = value.Nullable
+                        可空类型 = value.Nullable,
+                        其他信息 = new OtherInfo
+                        {
+                            最小长度 = value.MinLength,
+                            最大长度 = value.MaxLength,
+                            格式校验 = value.Pattern,
+                            最小值 = value.Minimum,
+                            最大值 = value.Maximum,
+                        }
                     };
                     properties.Add(s, responseModelInfo);
                 }

Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,10 @@ public class RequestModelInfo`
`24`	`24`	`/// 是否必传`
`25`	`25`	`/// </summary>`
`26`	`26`	`public bool 是否必传 { get; set; }`
	`27`	`+`
	`28`	`+ /// <summary>`
	`29`	`+ /// 其他信息`
	`30`	`+ /// </summary>`
	`31`	`+ public OtherInfo 其他信息 { get; set; }`
`27`	`32`	`}`
`28`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,5 +19,10 @@ public class ResponseModelInfo`
`19`	`19`	`/// 可空类型`
`20`	`20`	`/// </summary>`
`21`	`21`	`public bool 可空类型 { get; set; }`
	`22`	`+`
	`23`	`+ /// <summary>`
	`24`	`+ /// 其他信息`
	`25`	`+ /// </summary>`
	`26`	`+ public OtherInfo 其他信息 { get; set; }`
`22`	`27`	`}`
`23`	`28`	`}`