Swagger Starter 1.4.0发布:新增swagger功能开源与全局参数的配置。

时间:2022-05-05
本文章向大家介绍Swagger Starter 1.4.0发布:新增swagger功能开源与全局参数的配置。,主要内容包括版本基础、1.4.0的新功能、基本概念、基础应用、原理机制和需要注意的事项等,并结合实例形式分析了其使用技巧,希望通过本文能帮助到大家理解应用这部分内容。

该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档,简化原生使用swagger2的整合代码。

  • GitHub:https://github.com/dyc87112/spring-boot-starter-swagger
  • 码云:https://gitee.com/didispace/spring-boot-starter-swagger
  • 使用样例:https://github.com/dyc87112/swagger-starter-demo
  • 我的博客:http://blog.didispace.com
  • 我们社区:http://spring4all.com

小工具一枚,欢迎使用和Star支持,如使用过程中碰到问题,可以提出Issue,我会尽力完善该Starter

版本基础

  • Spring Boot:1.5.x
  • Swagger:2.7.x

1.4.0的新功能

  • Swagger功能启用配置
swagger.enabled=true

配置说明

  • 全局参数配置
swagger.globalOperationParameters[0].name=参数名
swagger.globalOperationParameters[0].description=描述信息
swagger.globalOperationParameters[0].modelRef=指定参数类型
swagger.globalOperationParameters[0].parameterType=指定参数存放位置,可选header,query,path,body.form
swagger.globalOperationParameters[0].required=指定参数是否必传,true,false

全局参数可以配置多个,通过数组下标指定,该参数也支持指定docket的配置,指定docket配置时会覆盖全局配置。