swagger知识点补充
1. swagger知识点补充
1.1. 概述
- 在swagger的使用过程中,除了网上常见的例子,还会有很多细节上的东西需要注意和改写,这里我列几点我使用过程中遇到的问题和改进方式
1.2. 知识点
1.2.1. 模型例子
- 我们在进行POST的请求的时候,尤其是增加一条数据,我们往往会有很多字段是不需要我们手动填写的,比如逻辑删除,创建时间,修改时间等等,我的需求就是再swagger界面的Example中不显示这些字段
- 实现方式

1.2.2. 判空
- 如上图所示,这不是swagger知识点,这里顺带讲下,需要在controller层入参加上
@Vaild

- 输入参数有误,效果如下

1.2.3. controller层中文字标注
- 效果如下,网上的例子大多没有设该属性

- 实现方式

1.2.4. 模型填充默认值
- 如下例子:swagger打开该接口的默认配置就是
example配的


1.2.5. 激活测试dev模式
- 再补充个非swagger的知识点,激活dev模式,在测试时比较好用
@RunWith(SpringRunner.class)
@SpringBootTest
@ActiveProfiles("dev")
@Slf4j
public class FundApplicationTests {
@Test
public void contextLoads() {
log.info("adafdafds");
}
}
1.2.6. schedule的cron定时任务
- 再补充个,定时任务的要求有时候可能觉得一个cron满足不了,不要执着于怎么写cron了,注解时可以注多个的
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {
@Repeatable注解就是表明了这个注解可以重复注
1.2.7. transient和@TableField(select = false)
- 虽然前面有讲到过,这里在重复声明一次,连我也觉得容易忘记,属性用
transient修饰,在配合jackson或fastjson的fj.setSerializerFeatures(SerializerFeature.SkipTransientField)配置,表示对controller层做切面,返回数据的json序列化会去掉该字段;而@TableField(select = false)注解的属性字段,表示用mybatis的sql查询,默认查全量字段时,该字段不查询 - 逻辑删除字段,添加
transient会导致逻辑删除模式失效
1.2.8. 逻辑删除
- 前面也讲到过逻辑删除的功能,它除了可以使得我们用
deleteById这样的操作变成逻辑删除,还可以使除了自定义语句的查询默认加上逻辑删除=未删除的条件,也就是说,像下列这样的查询操作,默认会加上del_flag=0,我们无需再多写这个字段的条件
User user = this.baseMapper.selectOne(Wrappers.<User>lambdaQuery().
select(User::getUsername, User::getSex, User::getNickName).eq(User::getUserId, userId));
swagger知识点补充的更多相关文章
- set集合,深浅拷⻉以及部分知识点补充
set集合,深浅拷⻉以及部分知识点补充内容:1. 基础数据类型补充2. set集合3. 深浅拷⻉主要内容: ⼀. 基础数据类型补充⾸先关于int和str在之前的学习中已经讲了80%以上了. 所以剩下的 ...
- Django 知识点补充
Django 知识点补充 1 Django如何在Model保存前做一定的固定操作,比如写一条日志 (1)利用Django的Model的Signal Dispatcher, 通过django.db.mo ...
- 从零开始的全栈工程师——html篇1.8(知识点补充与浏览器兼容性)
知识点补充 一.浏览器的兼容问题(关于浏览器的兼容问题 有很多大佬已经解释的很清楚了 这个得自己百度去多花点时间去了解 这里咱们只说一下前面的漏点) 浏览器兼容性问题又被称为网页兼容性或网站兼容性问题 ...
- python day4 元组/字典/集合类知识点补充
目录 python day4 元组/字典/集合类知识点补充 1. 元组tuple知识点补充 2. 字典dict的知识点补充 3. 基本数据类型set 4. 三元运算,又叫三目运算 5. 深复制浅复制 ...
- python 知识点补充
python 知识点补充 简明 python 教程 r 或 R 来指定一个 原始(Raw) 字符串 Python 是强(Strongly)面向对象的,因为所有的一切都是对象, 包括数字.字符串与 函数 ...
- java基础知识点补充---二维数组
#java基础知识点补充---二维数组 首先定义一个二维数组 int[][] ns={ {1,2,3,4}, {5,6,7,8}, {9,10,11,12}, {13,14,15,16} }; 实现遍 ...
- disruptor笔记之八:知识点补充(终篇)
欢迎访问我的GitHub https://github.com/zq2599/blog_demos 内容:所有原创文章分类汇总及配套源码,涉及Java.Docker.Kubernetes.DevOPS ...
- Jaeger知识点补充
欢迎访问我的GitHub https://github.com/zq2599/blog_demos 内容:所有原创文章分类汇总及配套源码,涉及Java.Docker.Kubernetes.DevOPS ...
- Mysql学习笔记(十)存储过程与函数 + 知识点补充(having与where的区别)
学习内容:存储程序与函数...这一章学的我是云里雾里的... 1.存储过程... Mysql存储过程是从mysql 5.0开始增加的一个新功能.存储过程的优点其实有很多,不过我觉得存储过程最重要的 ...
随机推荐
- Python3学习笔记09-字典
字典是另一种可变容器模型,且可存储任意类型对象. 字典的每个键值(key=>value)对用冒号(:)分割,每个对之间用逗号(,)分割,整个字典包括在花括号({})中 键必须是唯一的,但值则不必 ...
- Springboot分模块开发详解(1):建立父工程
基础服务,见下: base是父工程,base-entity是实体层,base-dao是DAO层,base-service是业务层,base-controller是WEB控制器层,base-web是页面 ...
- Go语言规格说明书 之 接口类型(Interface types)
go version go1.11 windows/amd64 本文为阅读Go语言中文官网的规则说明书(https://golang.google.cn/ref/spec)而做的笔记,介绍Go语言的 ...
- oracle11g客户端配置及使用(Windows系统)
一.安装Oracle客户端 本文环境: 操作系统:Windows XP Pro sp3(简体中文)32位 1. 首先去官网下载Oracle 11g (1) win32_11gR2_database_1 ...
- Java基础99 待续
1.待续 原创作者:DSHORE 作者主页:http://www.cnblogs.com/dshore123/ 原文出自:https://www.cnblogs.com/dshore123/p/107 ...
- 并发之AQS原理(三) 如何保证并发
并发之AQS原理(三) 如何保证并发 1. 如何保证并发 AbstractQueuedSynchronizer 维护了一个state(代表了共享资源)和一个FIFO线程等待队列(多线程竞争资源被阻塞时 ...
- 使用@property - 廖雪峰的官方网站
使用@property 阅读: 20616 在绑定属性时,如果我们直接把属性暴露出去,虽然写起来很简单,但是,没办法检查参数,导致可以把成绩随便改: s = Student() s.score = 9 ...
- unittest中更多的测试用例
随着软件功能的不断增加,对应的测试用例也会呈指数级增长.一个实现几十个功能的项目,对应的单 元测试用例可能达到上百个.如果把所有的测试用例都写在一个 test.py 文件中,那么这个文件会越来越臃肿, ...
- xxx is not in sudoers file 解决(转)
解决方案:首需要切换到root身份$su -(注意有- ,这和su是不同的,在用命令"su"的时候只是切换到root,但没有把root的环境变量传过去,还是当前用户的环境变量,用& ...
- day6作业--游戏人生完善
本节作业: 熟练使用类和模块,写一个交互性强.有冲突的程序. 一.作业目的 1.规范程序写法,要按照模块来规范书写: 2.类的使用,文件之间的调用练习: 3.思路的开阔,自己编写冲突,实现调用 ...