在线API文档使用Slf4j (个人使用仅供参考)

pom文件(这套只作用于2.5系列)

<!-- Spring Boot中的Spring Validation的依赖项,用于检查方法的参数的基本有效性 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<!-- Knife4j Spring Boot:在线API文档 -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>

注解作用

@Slf4j

放在一个类名上表是这个类的所有输出都可以打log.这种日志

@Api(tags = "1.1. XXX-XXX")

放在一个controller上可以修改

@Api表示在API文档中的显示需要配一个(tags 属性)

多个controller的哈 可以配个数字属性如1.0 1.0他采用数字先后排序

@ApiOperation("新增标签类别")

这个注解是表示请求方式上的名字是什么 有个(value=)这个属性如果只有一个参数可以不写@ApiOperationSupport(order = 100)

这个注解配合上一个注解使用 因为@ApiOperation没有排序功能 ApiOperationSupport具有排序功能 我比较喜欢 100是增 200 删  300 改 400 查

这个加在名称上 表示这个属性必须配置

重点这个 注解只是作用于文档的调试 不能作用于项目

example 表示举例

使用Validation框架检查请求参数

这个是在方法里边参数上加

加在属性上表示属性 具有不为空的要求

可以配合异常处理类用

不允许为空白

只能字符串使用

实际开发中 建议用这个写正则表达式

这两个必须配合使用 不然正则表达式会失效

表示最大多少最小多少 其实min默认就是0 可以不配

底层注解就是@MIN @MAX 这两个玩意

任何检查注解都必须有message属性

串加

处理服务器异常中 null导致的流量消耗

表示是否包含deta默认包含

修改以后表示为空不包含 有信息包含

我一般加在类上表示 有就包含 没有就拉倒

开发环境下

这个是最终的答案  一共三种自己适合那种用那种  这玩意有个东西 就是范围越小越优先 范围越大需要排队

如果遇到重载的可以考虑参数少的调用参数多的 大多数情况可以

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值