feat:注释文档修改

sunpengfei

2025-08-01 010d7d242d2b69857e855a092040e4b79481adb9

feat:注释文档修改

 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();

 FlexJobApi.Core/Utils/SwaggerUtils/FurionCustomOperationIdFilter.cs

New file
@@ -0,0 +1,28 @@
using 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)
        {
            // 获取控制器和动作信息（Furion 中通过 ActionDescriptor 获取）
            if (context.ApiDescription.ActionDescriptor is not ControllerActionDescriptor actionDescriptor)
                return;

            // 自定义 OperationId 规则：例如“控制器名_动作名”
            var controllerName = actionDescriptor.ControllerName;
            var actionName = actionDescriptor.ActionName;

            // 设置最终的 OperationId
            operation.OperationId = $"{controllerName}-{actionName}";
        }
    }
}

 FlexJobApi.Core/settings.json

@@ -11,7 +11,8 @@
          "Name": "孙鹏飞"
        }
      }
    ]
    ],
    "EnumToNumber": true
  },
  "CorsAccessorSettings": {
    "WithExposedHeaders": [

 FlexJobApi.User.Application/Auths/AuthAppService.cs

@@ -1,6 +1,7 @@
using 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;
        }

 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>

 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;
        }