From 010d7d242d2b69857e855a092040e4b79481adb9 Mon Sep 17 00:00:00 2001
From: sunpengfei <i@angelzzz.com>
Date: 星期五, 01 八月 2025 15:34:54 +0800
Subject: [PATCH] feat:注释文档修改
---
FlexJobApi.User.Application/FlexJobApi.User.Application.xml | 10 +++++-----
FlexJobApi.Core/settings.json | 3 ++-
FlexJobApi.Core/FlexJobApiCoreStartup.cs | 7 +++++++
FlexJobApi.Core/Utils/SwaggerUtils/FurionCustomOperationIdFilter.cs | 28 ++++++++++++++++++++++++++++
FlexJobApi.User.Application/Menus/MenuAppService.cs | 4 ++--
FlexJobApi.User.Application/Auths/AuthAppService.cs | 5 +++--
6 files changed, 47 insertions(+), 10 deletions(-)
diff --git a/FlexJobApi.Core/FlexJobApiCoreStartup.cs b/FlexJobApi.Core/FlexJobApiCoreStartup.cs
index e665ae2..2c53b2d 100644
--- a/FlexJobApi.Core/FlexJobApiCoreStartup.cs
+++ b/FlexJobApi.Core/FlexJobApiCoreStartup.cs
@@ -53,6 +53,11 @@
services.AddCorsAccessor();
+ services.AddSpecificationDocuments(options =>
+ {
+ options.OperationFilter<FurionCustomOperationIdFilter>();
+ });
+
services.AddControllers()
.AddNewtonsoftJson(options =>
{
@@ -92,6 +97,8 @@
app.UseInject(string.Empty);
+ app.UseSpecificationDocuments();
+
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
diff --git a/FlexJobApi.Core/Utils/SwaggerUtils/FurionCustomOperationIdFilter.cs b/FlexJobApi.Core/Utils/SwaggerUtils/FurionCustomOperationIdFilter.cs
new file mode 100644
index 0000000..2dbfe8e
--- /dev/null
+++ b/FlexJobApi.Core/Utils/SwaggerUtils/FurionCustomOperationIdFilter.cs
@@ -0,0 +1,28 @@
+锘縰sing Microsoft.AspNetCore.Mvc.Controllers;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace FlexJobApi.Core
+{
+ public class FurionCustomOperationIdFilter : IOperationFilter
+ {
+ public void Apply(OpenApiOperation operation, OperationFilterContext context)
+ {
+ // 鑾峰彇鎺у埗鍣ㄥ拰鍔ㄤ綔淇℃伅锛團urion 涓�氳繃 ActionDescriptor 鑾峰彇锛�
+ if (context.ApiDescription.ActionDescriptor is not ControllerActionDescriptor actionDescriptor)
+ return;
+
+ // 鑷畾涔� OperationId 瑙勫垯锛氫緥濡傗�滄帶鍒跺櫒鍚峗鍔ㄤ綔鍚嶁��
+ var controllerName = actionDescriptor.ControllerName;
+ var actionName = actionDescriptor.ActionName;
+
+ // 璁剧疆鏈�缁堢殑 OperationId
+ operation.OperationId = $"{controllerName}-{actionName}";
+ }
+ }
+}
diff --git a/FlexJobApi.Core/settings.json b/FlexJobApi.Core/settings.json
index 05ffed3..2809bcb 100644
--- a/FlexJobApi.Core/settings.json
+++ b/FlexJobApi.Core/settings.json
@@ -11,7 +11,8 @@
"Name": "瀛欓箯椋�"
}
}
- ]
+ ],
+ "EnumToNumber": true
},
"CorsAccessorSettings": {
"WithExposedHeaders": [
diff --git a/FlexJobApi.User.Application/Auths/AuthAppService.cs b/FlexJobApi.User.Application/Auths/AuthAppService.cs
index a2da39a..24379f4 100644
--- a/FlexJobApi.User.Application/Auths/AuthAppService.cs
+++ b/FlexJobApi.User.Application/Auths/AuthAppService.cs
@@ -1,6 +1,7 @@
锘縰sing FlexJobApi.Core;
using Furion.DynamicApiController;
using Furion.FriendlyException;
+using Furion.SpecificationDocument;
using MediatR;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
@@ -11,11 +12,11 @@
/// 璁よ瘉
/// </summary>
[Route("api/user/[controller]")]
- public class AuthAppServiceV1 : IDynamicApiController
+ public class AuthAppService : IDynamicApiController
{
private readonly IMediator mediator;
- public AuthAppServiceV1(IMediator mediator)
+ public AuthAppService(IMediator mediator)
{
this.mediator = mediator;
}
diff --git a/FlexJobApi.User.Application/FlexJobApi.User.Application.xml b/FlexJobApi.User.Application/FlexJobApi.User.Application.xml
index acc6456..9f844af 100644
--- a/FlexJobApi.User.Application/FlexJobApi.User.Application.xml
+++ b/FlexJobApi.User.Application/FlexJobApi.User.Application.xml
@@ -4,12 +4,12 @@
<name>FlexJobApi.User.Application</name>
</assembly>
<members>
- <member name="T:FlexJobApi.User.Application.AuthAppServiceV1">
+ <member name="T:FlexJobApi.User.Application.AuthAppService">
<summary>
璁よ瘉
</summary>
</member>
- <member name="M:FlexJobApi.User.Application.AuthAppServiceV1.PasswordLogin(FlexJobApi.Core.AuthPasswordLoginCommand)">
+ <member name="M:FlexJobApi.User.Application.AuthAppService.PasswordLogin(FlexJobApi.Core.AuthPasswordLoginCommand)">
<summary>
瀵嗙爜鐧诲綍
</summary>
@@ -36,19 +36,19 @@
淇濆瓨鑿滃崟
</summary>
</member>
- <member name="T:FlexJobApi.User.Application.MenuAppServiceV1">
+ <member name="T:FlexJobApi.User.Application.MenuAppService">
<summary>
鑿滃崟
</summary>
</member>
- <member name="M:FlexJobApi.User.Application.MenuAppServiceV1.AllQuery(FlexJobApi.Core.MenuAllQuery)">
+ <member name="M:FlexJobApi.User.Application.MenuAppService.AllQuery(FlexJobApi.Core.MenuAllQuery)">
<summary>
鏌ヨ鎵�鏈夎彍鍗�
</summary>
<param name="query"></param>
<returns></returns>
</member>
- <member name="M:FlexJobApi.User.Application.MenuAppServiceV1.Save(FlexJobApi.Core.MenuSaveCommand)">
+ <member name="M:FlexJobApi.User.Application.MenuAppService.Save(FlexJobApi.Core.MenuSaveCommand)">
<summary>
淇濆瓨鑿滃崟
</summary>
diff --git a/FlexJobApi.User.Application/Menus/MenuAppService.cs b/FlexJobApi.User.Application/Menus/MenuAppService.cs
index 678ab79..5b2104f 100644
--- a/FlexJobApi.User.Application/Menus/MenuAppService.cs
+++ b/FlexJobApi.User.Application/Menus/MenuAppService.cs
@@ -14,11 +14,11 @@
/// 鑿滃崟
/// </summary>
[Route("api/user/[controller]")]
- public class MenuAppServiceV1 : IDynamicApiController
+ public class MenuAppService : IDynamicApiController
{
private readonly IMediator mediator;
- public MenuAppServiceV1(IMediator mediator)
+ public MenuAppService(IMediator mediator)
{
this.mediator = mediator;
}
--
Gitblit v1.9.1