Swagger与Knife4j:日常开发的使用

在这里插入图片描述

前言

  • 在日常开发当中我们少不了用 Swagger 的注解,下面我就粗略讲一下我们日常开发当中比较常用的一些注解吧,同时项目当中配合使用:knife4j 对于联调接口来说是一个非常不错的体验。

Springboot 整合 Knife4j 教程

注解介绍与使用

页面展示:

  • 这里用的版本是: Swagger:3.0.0 Knife4j:3.0.3,对于 Knife4j 不熟悉同学可以去 github 直接搜这个了解一下
  • 使用 Knife4j 后的可视化界面

在这里插入图片描述

Swagger常用注解

  • @ApiOperation( ): 标注当前控制器接口的作用
  • @ApiImplicitParams({@ApiImplicitParam(),… }): 用于为:GET请求接口的参数解释
  • @ApiModelProperty( ): 标注类参数名
  • Swagger 详细的原理可以看我这篇文章: https://blog.csdn.net/Mango_Bin/article/details/115679246

在这里插入图片描述
在这里插入图片描述

KnIfe4j注解

  • @ApiOperationSupport(author = “xxxxx”): 标注改接口是谁写的,便于前端人员联调接口时遇到问题可以直接找到开发人员
  • Knlfe4j 框架的具体介绍: https://www.techgrow.cn/posts/e2246230.html

在这里插入图片描述

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值