广告
返回顶部
首页 > 资讯 > 后端开发 > ASP.NET >使用.NET6实现动态API
  • 249
分享到

使用.NET6实现动态API

2024-04-02 19:04:59 249人浏览 安东尼
摘要

目录开发环境项目地址项目目标编码约定核心代码使用示例apiLite是基于.net6直接将Service层生成动态api路由,可以不用添加Controller,支持模块插件化,在项目开

apiLite是基于.net6直接将Service层生成动态api路由,可以不用添加Controller,支持模块插件化,在项目开发中能够提高工作效率,降低代码量。

开发环境

  • .NET SDK 6.0.100-rc.2.21505.57
  • VS2022 Preview 7.0

项目地址

GitHub: https://github.com/known/ApiLite

项目目标

  • 根据Service动态生成api
  • 支持自定义路由模板(通过Route特性定义)
  • 支持模块插件化
  • 支持不同模块,相同Service名称的路由(命名空间需要有3级以上,例如:Com.Mod.XXX)
  • 自动根据方法名称判断请求方式,Get开头的方法名为GET请求,其他为POST请求

编码约定

  • 模块类库必须包含继承IModule接口的类
  • 需要生成api的Service必须继承IService接口
  • GET请求的方法必须以Get开头

核心代码

主要是ApiFeatureProvider和ApiConvention这两个自定义类来动态生成api,ApiFeatureProvider继承ControllerFeatureProvider,覆写IsController方法,判断服务类型是否符合Controller。ApiConvention实现了IApplicationModelConvention接口,实现动态添加Action。下面是主要代码,完整代码请在GitHub上下载。


static class ServiceExtension
{
    internal static WEBApplicationBuilder AddKApp(this WebApplicationBuilder builder, Action<AppOption>? action = null)
    {
        var option = new AppOption();
        action?.Invoke(option);
        ...
        ADDDynamicApi(mvcBuilder, option);//添加动态api
        return builder;
    }
 
    private static void AddDynamicApi(IMvcBuilder builder, AppOption option)
    {
        builder.ConfigureApplicationPartManager(m =>
        {
            m.ApplicationParts.Add(new AssemblyPart(typeof(IService).Assembly));
            foreach (var item in option.Modules)
            {
                item.Initialize();//初始化模块
                //将模块添加到ApplicationParts,这样才能发现服务类
                var assembly = item.GetType().Assembly;
                m.ApplicationParts.Add(new AssemblyPart(assembly));
            }
            m.FeatureProviders.Add(new ApiFeatureProvider());
        });
 
        builder.Services.Configure<MvcOptions>(o =>
        {
            o.Conventions.Add(new ApiConvention());
        });
    }
}
 
//判断服务类型是否为Controller
class ApiFeatureProvider : ControllerFeatureProvider
{
    protected override bool IsController(TypeInfo typeInfo)
    {
        if (!typeof(IService).IsAssignableFrom(typeInfo) ||
            !typeInfo.IsPublic ||
            typeInfo.IsAbstract ||
            typeInfo.IsGenericType)
            return false;
 
        return true;
    }
}
 
class ApiConvention : IApplicationModelConvention
{
    public void Apply(ApplicationModel application)
    {
        foreach (var controller in application.Controllers)
        {
            var type = controller.ControllerType;
            if (typeof(IService).IsAssignableFrom(type))
            {
                ConfigureApiExplorer(controller);
                ConfigureSelector(controller);
            }
        }
    }
 
    ...
 
    //构造路由模板
    private string GetRouteTemplate(ActionModel action)
    {
        if (action.Attributes != null && action.Attributes.Count > 0)
        {
            foreach (var item in action.Attributes)
            {
                if (item is RouteAttribute attribute)
                {
                    return attribute.Path;//返回自定义路由
                }
            }
        }
 
        var routeTemplate = new StringBuilder();
        //routeTemplate.Append("api");
        var names = action.Controller.ControllerType.Namespace.Split('.');
        if (names.Length > 2)
        {
            //支持不同模块相同类名,添加命名空间模块名作前缀
            routeTemplate.Append(names[^2]);
        }
 
        // Controller
        var controllerName = action.Controller.ControllerName;
        if (controllerName.EndsWith("Service"))
            controllerName = controllerName[0..^7];
 
        routeTemplate.Append($"/{controllerName}");
 
        // Action
        var actionName = action.ActionName;
        if (actionName.EndsWith("Async"))
            actionName = actionName[..^"Async".Length];
 
        if (!string.IsNullOrEmpty(actionName))
            routeTemplate.Append($"/{actionName}");
 
        return routeTemplate.ToString();
    }
}

使用示例


KHost.Run(args, o =>
{
    o.Modules.Add(new TestModule());//添加模块
});
 
class TestModule : IModule
{
    public void Initialize()
    {
    }
}
 
public class TestService : IService
{
    public string GetName(string name)
    {
        return $"Hello {name}";
    }
 
    public string SaveData(string data)
    {
        return $"{DateTime.Now:yyyy-MM-dd HH:mm:ss} {data}";
    }
 
    [Route("api/test")]
    public string GetCustMethod(string id)
    {
        return id;
    }
}

以上所述是小编给大家介绍的使用.NET6实现动态API,希望对大家有所帮助。在此也非常感谢大家对编程网网站的支持!

--结束END--

本文标题: 使用.NET6实现动态API

本文链接: https://www.lsjlt.com/news/160455.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • 使用.NET6实现动态API
    目录开发环境项目地址项目目标编码约定核心代码使用示例ApiLite是基于.NET6直接将Service层生成动态api路由,可以不用添加Controller,支持模块插件化,在项目开...
    99+
    2022-11-12
  • 如何使用.NET6实现动态API
    本篇文章为大家展示了如何使用.NET6实现动态API,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。ApiLite是基于.NET6直接将Service层生成动态api路由,可以不用添加Controll...
    99+
    2023-06-22
  • .NET6开发TodoList应用之实现API版本控制
    目录需求目标原理与思路实现添加Nuget Package并配置服务实现API版本控制一点扩展总结需求 API接口版本管理,对于一些规模稍大的企业应用来说,是经常需要关注的一大需求。尽...
    99+
    2022-11-12
  • 怎么使用jQuery的api实现动态效果
    本篇内容主要讲解“怎么使用jQuery的api实现动态效果”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“怎么使用jQuery的api实现动态效果”吧!为什么要学...
    99+
    2022-10-19
  • 使用.Net6中的WebApplication打造最小API
    .net6在preview4时给我们带来了一个新的API:WebApplication,通过这个API我们可以打造更小的轻量级API服务。今天我们来尝试一下如何使用WebApplic...
    99+
    2022-11-12
  • .NET6 Minimal API的使用方式是什么
    这篇文章主要介绍“.NET6 Minimal API的使用方式是什么”,在日常操作中,相信很多人在.NET6 Minimal API的使用方式是什么问题上存在疑惑,小编查阅了各式资料,整理出简单好用的...
    99+
    2023-06-21
  • .NET6 ConfigurationManager的实现及使用方式
    前言 友情提示:建议阅读本文之前先了解下.Net Core配置体系相关,也可以参考本人之前的文章《.Net Core Configuration源码探究 》然后对.Net Core的...
    99+
    2022-11-12
  • 关于.NET6 Minimal API的使用方式详解
    目录前言使用方式几行代码构建Web程序更改监听地址日志操作基础环境配置主机相关设置默认容器替换中间件相关请求处理路由约束模型绑定绑定示例自定义绑定总结前言 随着.Net6的发布,微软...
    99+
    2022-11-12
  • 怎么使用.NET6+Quartz实现定时任务
    这篇文章主要介绍“怎么使用.NET6+Quartz实现定时任务”,在日常操作中,相信很多人在怎么使用.NET6+Quartz实现定时任务问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”怎么使用.NET6+Qua...
    99+
    2023-07-05
  • .NET Core(.NET6)中gRPC使用实践
    目录一、简介二、创建gRPC服务端1.创建gRPC项目2.编写自己的服务三、创建gRPC客户端1.创建客户端项目2.grPC服务https的调用3.gRPC内网http调用4.IOC...
    99+
    2022-11-13
  • .NET6开发TodoList应用之实现ActionFilter
    目录需求目标原理与思路实现验证总结需求 Filter在.NET Web API项目开发中也是很重要的一个概念,它运行在执行MVC响应的Pipeline中执行,允许我们将一些可以在多个...
    99+
    2022-11-12
  • 使用js实现动态背景
    本文实例为大家分享了js实现动态背景的具体代码,供大家参考,具体内容如下 1.将下面的代码复制并存为js文件 window.onload = function () { ...
    99+
    2022-11-12
  • .NET6开发TodoList应用之使用AutoMapper实现GET请求
    目录需求目标原理与思路实现引入AutoMapper实现GET请求验证获取所有TodoList列表获取单个TodoList详情填一个POST文章里的坑总结需求 需求很简单:实现GET请...
    99+
    2022-11-12
  • 使用vs2022在.net6中调试带typescript的静态页面
    1、新建一个空的web项目 2、设计、建好目录结构 其中ts存放typescript源文件,web为网站根目录,scripts/js存放ts生成的js脚本。 index.html...
    99+
    2022-11-12
  • FluentMybatis实现mybatis动态sql拼装和fluent api语法
    目录开始第一个例子: Hello World新建演示用的数据库结构创建数据库表对应的Entity类运行测试来见证Fluent Mybatis的神奇配置spring bean定义使用J...
    99+
    2022-11-12
  • .NET6开发TodoList应用实现结构搭建
    目录1.TodoList需求简介2.开发工具2.1.NET 62.2Visual Studio Code2.3Hoppscotch3.Clean Architecture简介4.搭建...
    99+
    2022-11-12
  • .NET6开发TodoList应用之实现PUT请求
    目录需求目标原理与思路实现PUT请求领域事件的发布和响应验证总结需求 PUT请求本身其实可说的并不多,过程也和创建基本类似。在这篇文章中,重点是填上之前文章里留的一个坑,我们曾经给T...
    99+
    2022-11-12
  • 如何使用vs2022在.net6中调试带typescript的静态页面
    小编给大家分享一下如何使用vs2022在.net6中调试带typescript的静态页面,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!1、新建一个空的web项目2、设计、建好目录结构其中ts存放typescript源文件,...
    99+
    2023-06-22
  • Java使用Calendar类实现动态日历
    本文实例为大家分享了Java使用Calendar类实现动态日历的具体代码,供大家参考,具体内容如下 题目: 使用Calendar类实现一个动态日历,要求能够通过输入一个年份,月份显示...
    99+
    2022-11-12
  • PHP中使用Redis实现动态配置
    随着互联网技术的发展,Web应用程序的复杂度也不断增加,随之带来的是更多的配置选项。为了使应用程序具有更强的灵活性和可配置性,许多开发人员会使用动态配置的方式。在PHP应用程序中使用Redis存储和管理动态配置,是一种非常实用的方式。Red...
    99+
    2023-05-15
    PHP redis 动态配置
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作