使用ASP.NET Core封装接口请求参数格式

有些人获取接口请求参数是直接使用数据库实体类来获取的,这种方式虽然写起来很方便,但是会导致swagger接口文档出现很多没用的参数,让人看着不舒服。
在这里插入图片描述比如,新增用户只需要传用户名、密码、邮箱就可以了,但是实体类也包含了其他的属性,导致接口文档很难看,出现很多没用的参数,测试起来不方便。
要解决这个问题,我说一下目前见过的两种方案。

1、单独定义所谓的VO类或DTO类,将需要传递的属性定义在类里面,用接口来接收,但是保存数据库不能用VO类或DTO类,怎么办?
通常会做一次属性对拷,把同名的属性值从VO类或者DTO类拷贝到实体类里面。这种做法有个缺陷,一旦某张数据库表有几十个字段,也一个一个的去拷贝属性,写起来太麻烦了。所以,有些人会用c#里面的反射机制,分别遍历源对象和目标对象里面的属性,判断名称是否相等,再进行拷贝,封装成工具方法,或者使用第三方库。
这种算法需要写两层循环,性能并不是特别好。还有一种方法,就是把目标对象里面的属性名称保存到HashSet里面,再遍历源对象里面的属性,一一比较属性名是否包含在HashSet里面,再做属性拷贝,性能会好一点,但也就那样。
属性拷贝真的有必要吗?让我们再来看第二种方法。

2、可以定义一个类,继承实体类,作为请求参数

public class UserSaveParam:User
{[JsonIgnore]public long Id { get; set; }[JsonIgnore]public List<Role>? Roles { get; set; }
}

UserSaveParam类就是用来封装请求参数的格式的,它会把实体类里面所有的属性都继承下来,并且可以定义与实体类里面同名的属性,进行覆盖,加上JsonIgnore特性,表示相应的属性不需要做json解析,也就不会接收到相应的参数值了,其他参数值仍然可以正常接收。
然后,在接口加上这个参数

[HttpPost]
public Task<Result<object>> Save(UserSaveParam user)
{return ExecuteCatchAsync(() => userService.SaveAsync(user));
}

其中,SaveAsync方法是这样定义的

Task<int> SaveAsync(User user);

使用User类作为参数,这也就意味着,使用UserSaveParam类的对象保存数据库,不需要再做属性对拷,也就没有了这方面的性能开销了。
生成的swagger接口文档如下
在这里插入图片描述这下看起来干净多了

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/31563.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

数据可视化---绘制常用图表,组合图表,定制图表主题

题目一&#xff1a;绘制桑基图&#xff0c;展示某商铺新老客服群体的商品喜好 编写程序。根据第9.3.7&#xff0c;绘制桑基图&#xff0c;展示某商铺新老客服群体的商品喜好。 运行代码&#xff1a; #绘制桑基图&#xff0c;展示某商铺新老客服群体的商品喜好 from pyecharts…

使用Spring Boot和Redis实现邮箱注册与登录的验证码验证

引言 在现代web应用中&#xff0c;邮箱注册和登录是一种常见的用户验证方式。为了增强安全性和便捷性&#xff0c;我们可以利用Redis缓存存储验证码及其过期时间。本文将展示如何使用Spring Boot和Redis来实现邮箱验证码的注册与登录功能。 环境准备 1. 创建Spring Boot项目…

34.构建核心注入代码

上一个内容&#xff1a;33.获取入口点 以 33.获取入口点 它的代码为基础进行修改 实现的功能是把LoadLibrary函数注入到目标进程实现加载我们的模块。LoadLibrary只有有程序使用过了它的代码就会加载到内存中&#xff08;因为动态链接库是内存加载&#xff09;就是a程序要用L…

大数据-数据分析师利用excel绘图

你会用excel&#xff0c;统计数据吗&#xff1f;我是大数据工程师&#xff0c;但是我不会excel。那咋办&#xff1f; 用sql&#xff0c;统计&#xff0c;导出到excel&#xff0c;在用excel统计。本文主要讨论的是导出到excel后&#xff0c;画图。 图是什么&#xff1f; x和y…

【学习笔记】Mybatis-Plus(二) :常用注解

常用注解 注解含义应用场景TableName表名注解&#xff0c;标识实体类对应的表表名和实体类名称不一致TableId主键注解&#xff0c;标识实体类的主键主键需要指定自增长TableField字段注解数据库名称和字段名称不一致TableLogic逻辑删除不是真正物理删除数据KeySequence序列主键…

Ilya出走记:SSI的超级安全革命

图片&#xff5c;OpenAI官网 ©自象限原创 作者丨罗辑、程心 和OpenAI分道扬镳以后&#xff0c;Ilya“神秘而伟大”的事业终于揭开了面纱。 6月20日&#xff0c;前OpenAI核心创始人 Ilya Stuskever&#xff0c;在官宣离职一个月后&#xff0c;Ilya在社交媒体平台公开了…

由浅入深,走进深度学习(3)

今天分享的学习内容主要是完整构建神经网络&#xff0c; 包括&#xff1a;训练、测试、损失函数呀&#xff0c;计算精度呀&#xff0c;等等~ 用到的框架就是torch 在这里我也是对自己做一个学习记录&#xff0c;如果不符合大家的口味&#xff0c;大家划走就可以啦 可能没有…

掌握现代C++的模板元编程类型检测技术

最近写代码恰好用到了C模板元编程的类型检测能力&#xff0c;以前对其原理有个大概的印象&#xff0c;但随着C11/C17等新特性的加入&#xff0c;很多做法和以前不同了&#xff0c;借此机会重新梳理一下这方面的知识点。 void_t 的引入 在 C17 之前&#xff0c;模板编程中通常…

利氪科技拿下C轮超级融资,国产智能底盘黑马奔向黄金时代

“智能驾驶遗珠&#xff0c;国产替代富矿。” 这是海通证券在最近一期研报中&#xff0c;描述线控底盘产业的用语。它很巧妙地点明了&#xff0c;这个藏在车身之下的部分&#xff0c;拥有何种特征——稳坐技术体系的核心点位&#xff0c;拥有前景广阔的市场。 事实上&#xf…

mysql、mariadb 登录主机的含义,如何修改登录主机,如何删除登录主机

MariaDB版本: 10.3.39 登录主机的含义&#xff1a; 参考 1 阿风说事&#xff1a;说世间百态、聊奇闻趣事&#xff0c;分享个人观点和独到见解 2 mysql授权localhost&%区别及一直授权错误解决办法&#xff08;安装openstack有感&#xff09; 3 ERROR 1396 (HY000): Operat…

为什么要学习PMP

学习PMP&#xff08;项目管理专业人士认证&#xff09;能够在职场竞争力、薪资待遇、项目管理技能等方面带来显著的提升。以下是学习PMP的具体分析&#xff1a; 1、职场竞争力 升职加薪&#xff1a;学习PMP能够提升个人在项目中的管理能力和解决问题的能力&#xff0c;从而在…

一问搞懂Linux信号【上】

Linux信号在Linux系统中的地位仅此于进程间通信&#xff0c;其重要程度不言而喻。本文我们将从信号产生&#xff0c;信号保存&#xff0c;信号处理三个方面来讲解信号。 &#x1f6a9;结合现实认识信号 在讲解信号产生之前&#xff0c;我们先做些预备的工作。 现实生活中信号…

vue3-openlayers 轨迹回放(历史轨迹),实时轨迹

vue3-openlayers 轨迹回放&#xff08;历史轨迹&#xff09;&#xff0c;实时轨迹 本篇介绍一下使用vue3-openlayers轨迹回放&#xff08;历史轨迹&#xff09;&#xff0c;实时轨迹 1 需求 轨迹回放&#xff08;历史轨迹&#xff09;实时轨迹 2 分析 可以使用和上一篇相同…

编译原理-各章典型题型+思路求解

第2章文法和语言习题 基础知识&#xff1a; 思路&#xff1a; 基础知识&#xff1a; 思路&#xff1a; 基础知识&#xff1a; 编译原理之 短语&直接短语&句柄 定义与区分_编译原理短语,直接短语,句柄-CSDN博客 思路&#xff1a; 题目&#xff1a; 基础解释&#xff1a…

【PID _stm32 教程】

【PID电机速度闭环控制-PID算法(章节:8.3-PID算法初步体验与算法理解)】 https://www.bilibili.com/video/BV1q341197kn

关于使用tensorflow_gpu遇到的问题

前言 我使用的是tensorflow_gpu2.6与python3.9&#xff0c;还要下载cuda与cudnn。 numpy版本问题 AttributeError: module numpy has no attribute object. np.object was a deprecated alias for the builtin object. To avoid this error in existing code, use object by i…

一种快速设计PCB外壳的方法

设计PCB外壳比较好用的工具是SW但是有时候需要快速设计外壳的情况下使用立创EDA的外壳设计功能很好用&#xff0c;设计完成之后可以直接导出STL文件&#xff1a; 可以看到设计的外壳还是蛮精美的&#xff1a; 特别注意&#xff0c;设计外壳的时候要考虑如何把PCB放进壳子中&…

[Day 17] 區塊鏈與人工智能的聯動應用:理論、技術與實踐

區塊鏈在金融業的應用 前言 區塊鏈技術作為一種去中心化的分佈式賬本技術&#xff0c;自其誕生以來便展示出極大的潛力&#xff0c;特別是在金融領域。區塊鏈技術可以通過提供透明性、安全性和效率來改變金融業的運作方式。在本文中&#xff0c;我們將深入探討區塊鏈在金融業…

【文心智能体大赛】迎接属于你的休闲娱乐导师!

迎接属于你的休闲娱乐导师&#xff01; 前言创建智能体发布智能体最后结语 前言 文心智能体平台AgentBuilder 是百度推出的基于文心大模型的智能体&#xff08;Agent&#xff09;平台&#xff0c;支持广大开发者根据自身行业领域、应用场景&#xff0c;选取不同类型的开发方式&…

【秋招刷题打卡】Day01-自定义排序

Day01-自定排序 前言 给大家推荐一下咱们的 陪伴打卡小屋 知识星球啦&#xff0c;详细介绍 >笔试刷题陪伴小屋-打卡赢价值丰厚奖励 < ⏰小屋将在每日上午发放打卡题目&#xff0c;包括&#xff1a; 一道该算法的模版题 (主要以力扣&#xff0c;牛客&#xff0c;acwin…