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高并发编程之CAS实现无锁队列代码实例

    Java高并发编程之CAS实现无锁队列代码实例

    这篇文章主要介绍了Java高并发编程之CAS实现无锁队列代码实例,在多线程操作中,我们通常会添加锁来保证线程的安全,那么这样势必会影响程序的性能,那么为了解决这一问题,于是就有了在无锁操作的情况下依然能够保证线程的安全,需要的朋友可以参考下
    2023-12-12
  • SpringBoot集成Redis之配置、序列化与持久化方式

    SpringBoot集成Redis之配置、序列化与持久化方式

    本文介绍了Redis的基本概念、常用数据类型及操作、SpringBoot整合Redis的方法、高级特性与安全性、性能优化、测试与部署、数据一致性及版本更新等内容,通过本文的学习,读者可以掌握Redis的使用方法,并在实际项目中发挥其优势
    2024-11-11
  • Java并发编程示例(八):处理线程的非受检异常

    Java并发编程示例(八):处理线程的非受检异常

    这篇文章主要介绍了Java并发编程示例(八):处理线程的非受检异常,Java为我们提供了一种机制,专门用于处理由Thread对象抛出的非受检异常,以避免程序的退出,需要的朋友可以参考下
    2014-12-12
  • SpringBoot启动后执行方法的五种实现方式

    SpringBoot启动后执行方法的五种实现方式

    本文介绍了SpringBoot中五种在项目启动后执行方法的方式,包括实现CommandLineRunner和ApplicationRunner接口、实现ApplicationListener接口、使用@PostConstruct注解以及实现InitializingBean接口,每种方式都有其特点和适用场景
    2025-02-02
  • java快速排序和选择排序实现实例解析

    java快速排序和选择排序实现实例解析

    这篇文章主要为大家介绍了java快速排序和选择排序实现实例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • Java集合删除元素ArrayList实例详解

    Java集合删除元素ArrayList实例详解

    这篇文章主要介绍了Java集合删除元素ArrayList实例详解的相关资料,需要的朋友可以参考下
    2017-04-04
  • Jmeter环境搭建及安装步骤

    Jmeter环境搭建及安装步骤

    Jmeter是纯Java开发的,能够运行Java程序的系统一般都可以运行Jmeter,本文以windows下安装步骤为例分步骤给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧
    2021-12-12
  • Java项目部署的完整流程(超详细!)

    Java项目部署的完整流程(超详细!)

    我相信很多Java新手都会遇到这样一个问题,跟着教材敲代码,很容易,但是让他完整的实现一个应用项目却不会,下面这篇文章主要给大家介绍了关于Java项目部署的完整流程,需要的朋友可以参考下
    2022-07-07
  • zookeeper监听器原理的详解

    zookeeper监听器原理的详解

    今天小编就为大家分享一篇关于zookeeper监听器原理的详解,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • SpringBoot动态定时功能实现方案详解

    SpringBoot动态定时功能实现方案详解

    在SpringBoot项目中简单使用定时任务,不过由于要借助cron表达式且都提前定义好放在配置文件里,不能在项目运行中动态修改任务执行时间,实在不太灵活。现在我们就来实现可以动态修改cron表达式的定时任务,感兴趣的可以了解一下
    2022-11-11

最新评论