library/simapi-net
1
0
Fork 0
Code Pull Requests Activity

update v10

Browse Source
This commit is contained in:
xrain
2025-12-18 09:08:35 +08:00
parent 2499912204
commit 90124b6e67
7 changed files with 63 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
SwaggerFilters/AesBodyOperationFilter.cs
+2 -1
View File
@@ -1,10 +1,11 @@
using System.Collections.Generic;
using System.Linq;
using Microsoft.OpenApi;
using SimApi.Attributes;
namespace SimApi.SwaggerFilters;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Reflection;
SwaggerFilters/GlobalDynamicObjectSchemaFilter.cs
+28 -20
View File
@@ -1,27 +1,26 @@
using System;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Collections;
using System.Collections.Generic;
using System.Reflection;
using Microsoft.OpenApi.Any;
using System.Text.Json.Nodes;
namespace SimApi.SwaggerFilters;
public class GlobalDynamicObjectSchemaFilter : ISchemaFilter
{
public void Apply(OpenApiSchema schema, SchemaFilterContext context)
public void Apply(IOpenApiSchema schema, SchemaFilterContext context)
{
if (!IsDynamicObjectType(context.Type)) return;
schema.AdditionalPropertiesAllowed = true;
schema.AdditionalProperties = new OpenApiSchema
var oaSchema = schema as OpenApiSchema;
oaSchema.AdditionalPropertiesAllowed = true;
oaSchema.AdditionalProperties = new OpenApiSchema
{
Type = "object", // 表示 value 可以是任意类型（兼容所有类型）
Nullable = true
Type = JsonSchemaType.Object, // 表示 value 可以是任意类型（兼容所有类型）
};
// 2. 覆盖默认示例，使用包含多种类型的示例
schema.Example = CreateMultiTypeExample();
oaSchema.Example = CreateMultiTypeExample();
}
// 判断是否为需要处理的“动态对象”类型
@@ -33,30 +32,39 @@ public class GlobalDynamicObjectSchemaFilter : ISchemaFilter
{
return true;
}
if (type == typeof(object))
{
return true;
}
return type.Name.Contains("AnonymousType") && type.Namespace == null;
}
// 创建包含多种类型的示例（覆盖默认的 string 示例）
private OpenApiObject CreateMultiTypeExample()
private JsonNode CreateMultiTypeExample()
{
return new OpenApiObject
return new JsonObject
{
["stringProp"] = new OpenApiString("example string"), // 字符串
["numberProp"] = new OpenApiInteger(123), // 数字
["boolProp"] = new OpenApiBoolean(true), // 布尔值
["objectProp"] = new OpenApiObject // 嵌套对象
// 字符串类型：JsonValue.Create 包装字符串
["stringProp"] = JsonValue.Create("example string"),
// 数字类型：支持 int/long/double 等，JsonValue 自动适配
["numberProp"] = JsonValue.Create(123),
// 布尔类型
["boolProp"] = JsonValue.Create(true),
// 嵌套对象：JsonObject 对应 OpenApiObject
["objectProp"] = new JsonObject
{
["nestedKey"] = new OpenApiString("nested value")
["nestedKey"] = JsonValue.Create("nested value")
},
["arrayProp"] = new OpenApiArray // 数组
// 数组类型：JsonArray 对应 OpenApiArray
["arrayProp"] = new JsonArray
{
new OpenApiInteger(1),
new OpenApiString("two")
}
JsonValue.Create(1), // 数组内数字
JsonValue.Create("two") // 数组内字符串
},
// 可选：添加 null 值示例（若需要）
["nullProp"] = null
};
}
}
SwaggerFilters/SimApiAuthOperationFilter.cs
+17 -21
View File
@@ -1,7 +1,7 @@
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi;
using Swashbuckle.AspNetCore.SwaggerGen;
using SimApi.Attributes;
@@ -18,28 +18,24 @@ namespace SimApi.SwaggerFilters
||
// 控制器上有 [SimApiAuth]（继承到所有方法）
context.MethodInfo.DeclaringType?.GetCustomAttributes<SimApiAuthAttribute>(true).Any() == true;
if (requiresAuth)
if (!requiresAuth) return;
// 关键修复：正确构造 OpenApiSecuritySchemeReference（匹配键类型要求）
var securitySchemeRef = new OpenApiSecuritySchemeReference(
referenceId: "SimApiAuth", // 必须与 AddSecurityDefinition 的 ID 一致
hostDocument: null,
externalResource: null
);
// 给 Security 赋值（确保键类型是 OpenApiSecuritySchemeReference）
operation.Security ??= new List<OpenApiSecurityRequirement>();
operation.Security.Add(new OpenApiSecurityRequirement
{
// 添加授权要求：关联步骤 2 中定义的 "SimApiAuth" 安全方案
operation.Security = new List<OpenApiSecurityRequirement>
{
new OpenApiSecurityRequirement
{
{
new OpenApiSecurityScheme
{
Reference = new OpenApiReference
{
Type = ReferenceType.SecurityScheme,
Id = "SimApiAuth" // 必须与 AddSecurityDefinition 的第一个参数一致
}
},
[] // 无需指定作用域（scope）时留空
}
}
};
}
// 未标记 [SimApiAuth] 的接口：不添加安全要求，Swagger 不显示锁图标
securitySchemeRef,
[]
}
});
}
}
}
SwaggerFilters/SimApiResponseOperationFilter.cs
+1 -1
View File
@@ -1,7 +1,7 @@
using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Reflection;
using System.Threading.Tasks;
SwaggerFilters/SimApiSignOperationFilter.cs
+10 -6
View File
@@ -3,7 +3,7 @@ using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi;
using SimApi.Attributes;
using SimApi.ModelBinders;
using Swashbuckle.AspNetCore.SwaggerGen;
@@ -67,20 +67,24 @@ public class SimApiSignOperationFilter(IServiceProvider serviceProvider) : IOper
signParameters.AddRange(keyProvider.SignFields.Where(x => x != keyProvider.AppIdName)
.Select(f => (f, string.Empty, true)));
operation.Parameters ??= new List<IOpenApiParameter>();
foreach (var (name, description, required) in signParameters)
{
if (operation.Parameters?.Any(p => p.Name == name) == true)
{
var tmp = operation.Parameters?.FirstOrDefault(p => p.Name == name);
if (tmp != null)
if (tmp is OpenApiParameter concreteParam)
{
tmp.Required = required;
tmp.Description = description;
// 重新赋值只读属性（通过实例化新对象覆盖，或直接修改具体类的可写属性）
concreteParam.Required = required; // OpenApiParameter 的 Required 有 setter
concreteParam.Description = description;
}
continue;
}
operation.Parameters ??= new List<OpenApiParameter>();
operation.Parameters ??= new List<IOpenApiParameter>();
operation.Parameters.Add(new OpenApiParameter
{
Name = name,
@@ -89,7 +93,7 @@ public class SimApiSignOperationFilter(IServiceProvider serviceProvider) : IOper
Required = required,
Schema = new OpenApiSchema
{
Type = "string" // 签名相关参数通常为字符串类型
Type = JsonSchemaType.String // 签名相关参数通常为字符串类型
}
});
}