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的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java全版本特性与用法示例(含总览 + 分版本要点)

    Java全版本特性与用法示例(含总览 + 分版本要点)

    Java自JDK8开启现代化演进以来,始终遵循半年特性版本+两年LTS(长期支持)版本的发布节奏,持续在语言表达力、并发性能、开发体验、安全能力四大维度突破,这篇文章主要介绍了Java全版本特性与用法(含总览+分版本要点)的相关资料,需要的朋友可以参考下
    2026-05-05
  • 用Java设计模式中的观察者模式开发微信公众号的例子

    用Java设计模式中的观察者模式开发微信公众号的例子

    这篇文章主要介绍了用Java设计模式中的观察者模式开发微信公众号的例子,这里Java的微信SDK等部分便不再详述,只注重关键部分和开发过程中观察者模式优点的体现,需要的朋友可以参考下
    2016-02-02
  • JDK21对虚拟线程的几种用法实践指南

    JDK21对虚拟线程的几种用法实践指南

    虚拟线程是Java中的一种轻量级线程,由JVM管理,特别适合于I/O密集型任务,这篇文章主要介绍了JDK21对虚拟线程的几种用法,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-09-09
  • Java IO三大模型(BIO/NIO/AIO)的使用总结

    Java IO三大模型(BIO/NIO/AIO)的使用总结

    相信很多Java开发刚接触IO模型时,都会被「BIO、NIO、AIO」「同步、异步、阻塞、非阻塞」这些概念绕晕,下面就来详细的介绍一下 IO三大模型的使用,感兴趣的可以了解一下
    2026-02-02
  • Spring处理@Async导致的循环依赖失败问题的方案详解

    Spring处理@Async导致的循环依赖失败问题的方案详解

    这篇文章主要为大家详细介绍了SpringBoot中的@Async导致循环依赖失败的原因及其解决方案,文中的示例代码讲解详细,感兴趣的可以学习一下
    2022-07-07
  • ssm mybatis如何配置多个mapper目录

    ssm mybatis如何配置多个mapper目录

    这篇文章主要介绍了ssm mybatis如何配置多个mapper目录,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教。
    2022-01-01
  • springboot+vue实现Token自动续期(双Token方案)

    springboot+vue实现Token自动续期(双Token方案)

    双Token方案通过访问令牌和刷新令牌提高用户登录安全性和体验,访问令牌有效期短,包含用户信息,用于请求校验,本文就来介绍一下springboot+vue实现Token自动续期(双Token方案),感兴趣的可以了解一下
    2024-10-10
  • java 中@Deprecated 注解的实例详解

    java 中@Deprecated 注解的实例详解

    这篇文章主要介绍了java 中@Deprecated 注解的实例详解的相关资料,这里对@Deprecated注解进行了详细介绍,希望能帮助到大家,需要的朋友可以参考下
    2017-08-08
  • Java聊天室之实现使用Socket传递音频

    Java聊天室之实现使用Socket传递音频

    这篇文章主要为大家详细介绍了Java简易聊天室之使用Socket实现传递音频功能,文中的示例代码讲解详细,具有一定的借鉴价值,需要的可以了解一下
    2022-10-10
  • 深入浅出RocketMQ的事务消息

    深入浅出RocketMQ的事务消息

    RocketMQ事务消息(Transactional Message)是指应用本地事务和发送消息操作可以被定义到全局事务中,要么同时成功,要么同时失败。本文主要介绍了RocketMQ事务消息的相关知识,需要的可以参考一下
    2023-04-04

最新评论