Java中Swagger框架的使用详解

 更新时间:2023年08月30日 11:06:02   作者:余生海  
这篇文章主要介绍了Java框架Swagger的使用详解,在开发期间接口会因业务的变更频繁而变动,如果需要实时更新接口文档,这是一个费时费力的工作,Swagger应运而生,他可以轻松的整合进框架并通过一系列注解生成强大的API文档,需要的朋友可以参考下

简介

  • 由于架构革新,进入了前后端分离,服务端只需提供RESTful API的时代。
  • 而构建RESTful API会考虑到多终端的问题,这样就需要面对多个开发人员甚至多个开发团队。
  • 为了减少与其他团队对接的沟通成本,我们通常会写好对应的API接口文档。
  • 从最早开始的word文档,到后续的showdoc,都能减少很多沟通成本,但随之带来的问题也比较麻烦。在开发期间接口会因业务的变更频繁而变动,如果需要实时更新接口文档,这是一个费时费力的工作。
  • 为了解决上面的问题,Swagger应运而生。他可以轻松的整合进框架,并通过一系列注解生成强大的API文档。他既可以减轻编写文档的工作量,也可以保证文档的实时更新,将维护文档与修改代码融为一体,是目前较好的解决方案。

常用注解

  • @Api()用于类;
  • 表示标识这个类是swagger的资源
  • @ApiOperation()用于方法;
  • 表示一个http请求的操作
  • @ApiParam()用于方法,参数,字段说明;
  • 表示对参数的添加元数据(说明或是否必填等)
  • @ApiModel()用于类
  • 表示对类进行说明,用于参数用实体类接收
  • @ApiModelProperty()用于方法,字段
  • 表示对model属性的说明或者数据操作更改
  • @ApiIgnore()用于类,方法,方法参数
  • 表示这个方法或者类被忽略
  • @ApiImplicitParam() 用于方法
  • 表示单独的请求参数
  • @ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam

代码示例

  • @Api
@Api(value = "用户博客", tags = "博客接口")
public class NoticeController {
}
  • @ApiOperation
@GetMapping("/detail")
@ApiOperation(value = "获取用户详细信息", notes = "传入notice")
public R<Notice> detail(Integer id) {
   Notice detail = noticeService.getOne(id);
   return R.data(detail );
}
  • @ApiResponses
@GetMapping("/detail")
@ApiOperation(value = "获取用户详细信息", notes = "传入notice")
@ApiResponses(value = {@ApiResponse(code = 500, msg= "INTERNAL_SERVER_ERROR", response = R.class)})
public R<Notice> detail(Integer id) {
   Notice detail = noticeService.getOne(id);
   return R.data(detail );
}
  • @ApiImplicitParams
@GetMapping("/list")
@ApiImplicitParams({
   @ApiImplicitParam(name = "category", value = "公告类型", paramType = "query", dataType = "integer"),
   @ApiImplicitParam(name = "title", value = "公告标题", paramType = "query", dataType = "string")
})
@ApiOperation(value = "分页", notes = "传入notice")
public R<IPage<Notice>> list(@ApiIgnore @RequestParam Map<String, Object> notice, Query query) {
   IPage<Notice> pages = noticeService.page(Condition.getPage(query), Condition.getQueryWrapper(notice, Notice.class));
   return R.data(pages );
}
  • @ApiParam
@PostMapping("/remove")
@ApiOperation(value = "逻辑删除", notes = "传入notice")
public R remove(@ApiParam(value = "主键集合") @RequestParam String ids) {
   boolean temp = noticeService.deleteLogic(Func.toIntList(ids));
   return R.status(temp);
}
  • @ApiModel 与 @ApiModelProperty
@Data
@ApiModel(value = "BladeUser ", description = "用户对象")
public class BladeUser implements Serializable {
   private static final long serialVersionUID = 1L;
   @ApiModelProperty(value = "主键", hidden = true)
   private Integer userId;
   @ApiModelProperty(value = "昵称")
   private String userName;
   @ApiModelProperty(value = "账号")
   private String account;
   @ApiModelProperty(value = "角色id")
   private String roleId;
   @ApiModelProperty(value = "角色名")
   private String roleName;
}
  • @ApiIgnore()
@ApiIgnore()
@GetMapping("/detail")
public R<Notice> detail(Integer id) {
   Notice detail = noticeService.getOne(id);
   return R.data(detail );
}

到此这篇关于Java中间件Swagger的使用详解的文章就介绍到这了,更多相关Swagger的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot异步调用方法实现场景代码实例

    SpringBoot异步调用方法实现场景代码实例

    这篇文章主要介绍了SpringBoot异步调用方法实现场景代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • java连接MySQL数据库实现代码

    java连接MySQL数据库实现代码

    这篇文章主要为大家详细介绍了java连接MySQL数据库实现代码,感兴趣的小伙伴们可以参考一下
    2016-06-06
  • 使用监听器对Spring bean id进行唯一校验过程解析

    使用监听器对Spring bean id进行唯一校验过程解析

    这篇文章主要介绍了使用监听器对Spring bean id进行唯一校验过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08
  • Java实现读取项目中文件(.json或.properties)的方法详解

    Java实现读取项目中文件(.json或.properties)的方法详解

    这篇文章主要为大家详细介绍了Java实现读取项目中文件的方法,例如.json或.properties,文中的示例代码讲解详细,感兴趣的小伙伴可以了解一下
    2023-04-04
  • FP-Growth算法的Java实现+具体实现思路+代码

    FP-Growth算法的Java实现+具体实现思路+代码

    FP-Growth算法比Apriori算法快很多(但是却比不上时间,how time slipped away)。在网上搜索后发现Java实现的FP-Growth算法很少,且大多数不太能理解):太菜。所以就自己实现了一下。这篇文章重点介绍一下我的Java实现
    2021-06-06
  • Java 将list集合数据按照时间字段排序的方法

    Java 将list集合数据按照时间字段排序的方法

    这篇文章主要介绍了Java 将list集合数据按照时间字段排序,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-03-03
  • Java 8 Stream流强大的原理

    Java 8 Stream流强大的原理

    这篇文章主要介绍了Java 8 Stream流强大的原理,Java 8 API添加了一个新的抽象称为流Stream,可以让你以一种声明的方式处理数据。本文会对Stream的实现原理进行剖析,具有一定的参考价值,需要的朋友可以参考一下
    2021-12-12
  • java简单操作word实例

    java简单操作word实例

    这篇文章主要为大家详细介绍了java简单操作word实例,感兴趣的朋友可以参考一下
    2016-03-03
  • 解析Java并发Exchanger的使用

    解析Java并发Exchanger的使用

    Exchanger是java 5引入的并发类,Exchanger顾名思义就是用来做交换的。这里主要是两个线程之间交换持有的对象。当Exchanger在一个线程中调用exchange方法之后,会等待另外的线程调用同样的exchange方法。两个线程都调用exchange方法之后,传入的参数就会交换。
    2021-06-06
  • Spring中常见的7种BeanDefinition详解

    Spring中常见的7种BeanDefinition详解

    在 Spring 容器中,我们广泛使用的是一个一个的 Bean,BeanDefinition 从名字上就可以看出是关于 Bean 的定义,下面就跟随小编一起深入了解一下常见的7中BeanDefinition吧
    2023-09-09

最新评论