.net Core 使用Panda.DynamicWebApi动态构造路由

我们以前是通过创建controller来创建API,通过controller来显示的生成路由,这里我们讲解下如何不通过controller,构造API路由

  1. 安装
bash 复制代码
Panda.DynamicWebApi         1.2.2   1.2.2
Swashbuckle.AspNetCore      6.2.3   6.2.3
  1. 添加ServiceActionRouteFactory
csharp 复制代码
using Microsoft.AspNetCore.Mvc.ApplicationModels;
using Panda.DynamicWebApi;
using System.Reflection;

namespace DynamicControllerAPI.Dynamic
{
    public class ServiceActionRouteFactory : IActionRouteFactory
    {
        public string CreateActionRouteModel(string areaName, string controllerName, ActionModel action)
        {
            var controllerType = action.ActionMethod.DeclaringType;
            var serviceAttribute = controllerType.GetCustomAttribute<ServiceAttribute>();

            var _controllerName = serviceAttribute.ServiceName == string.Empty ? controllerName.Replace("Service", "") : serviceAttribute.ServiceName.Replace("Service", "");

            return $"api/{_controllerName}/{action.ActionName.Replace("Async", "")}";
        }
    }
}
  1. 添加ServiceLocalSelectController
csharp 复制代码
public class ServiceLocalSelectController : ISelectController
    {
        public bool IsController(Type type)
        {
            return type.IsPublic && type.GetCustomAttribute<ServiceAttribute>() != null;
        }
    }
  1. 添加注解
csharp 复制代码
[AttributeUsage(AttributeTargets.Class)]
    public class ServiceAttribute : Attribute
    {
        public ServiceAttribute()
        {
            ServiceName = string.Empty;
        }

        public ServiceAttribute(string serviceName)
        {
            ServiceName = serviceName;
        }

        public string ServiceName { get; }
    }
  1. 添加自定义服务
csharp 复制代码
namespace DynamicControllerAPI.Dynamic
{
    [Service("Other.Server")]
    public class OtherService
    {
        public readonly SingleClass _singleClass;

        public OtherService(SingleClass singleClass)
        {
            _singleClass = singleClass;
        }

        public int Create()
        {
            return 100;
        }

        public string GetUserName()
        {
            return _singleClass.getName();
        }

        public Task<int> TaskIntAsync()
        {
            return Task.FromResult(100);
        }
    }

    public class SingleClass

    {
        public string getName()
        {
            return "ellis";
        }
    }
}
  1. 修改工程文件DynamicControllerAPI.csproj添加如下

其中xml名字与工程名一致

bash 复制代码
  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
    <DocumentationFile>bin\Debug\net6.0\DynamicControllerAPI.xml</DocumentationFile>
    <NoWarn>1701;1702;CS1591</NoWarn>
  </PropertyGroup>
  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
    <DocumentationFile>bin\Release\net6.0\DynamicControllerAPI.xml</DocumentationFile>
    <NoWarn>1701;1702;CS1591</NoWarn>
  </PropertyGroup>
  1. 依赖注入
bash 复制代码
builder.Services.AddDynamicWebApiCore<ServiceLocalSelectController, ServiceActionRouteFactory>();

// 注册Swagger生成器,定义一个和多个Swagger 文档
builder.Services.AddSwaggerGen(options =>
{
    options.SwaggerDoc("v1", new OpenApiInfo() { Title = "Dynamic WebApi", Version = "v1" });

    // 确保包含所有控制器
    options.DocInclusionPredicate((docName, description) => true);

    // XML 文件路径
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    Console.WriteLine($"XML Path: {xmlPath}"); // 调试路径输出
    options.IncludeXmlComments(xmlPath);
});

builder.Services.AddSingleton<SingleClass>();

// 启用中间件服务生成Swagger作为JSON终结点
app.UseSwagger();

// 启用中间件服务对swagger-ui,指定Swagger JSON终结点
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Dynamic WebApi v1");
});

官网

源码

相关推荐
技术拾荒者9 小时前
.net core mvc 控制器中页面跳转
后端·c#·asp.net·mvc·.netcore
时光追逐者12 小时前
Visual Studio 2022:一个功能全面且强大的IDE
ide·c#·.net·.netcore·visual studio
.Net Core 爱好者3 天前
ASP .NET CORE 6 在项目中集成WatchDog开源项目
c#·.net·.netcore
想起你的日子3 天前
.net core 接口,动态接收各类型请求的参数
.netcore
qq_383139843 天前
Quartz实现定时调用接口(.net core2.0)
.netcore
时光追逐者3 天前
一个.NET开源、轻量级的运行耗时统计库 - MethodTimer
开源·c#·asp.net·.net·.netcore·微软技术
小兜全糖(xdqt)4 天前
.net core NPOI以及NOPI mapper
.netcore
时光追逐者4 天前
C#/.NET/.NET Core技术前沿周刊 | 第 11 期(2024年10.21-10.31)
开发语言·开源·c#·.net·.netcore·微软技术
时光追逐者4 天前
C#/.NET/.NET Core优秀项目和框架2024年10月简报
开发语言·开源·c#·.net·.netcore·微软技术