SpringBoot中swagger的使用

 更新时间:2021年05月07日 10:18:08   作者:代码呆嘛  
这篇文章主要介绍了SpringBoot中swagger的使用,文中有非常详细的代码示例,对正在学习swagger的小伙伴们有非常好的帮助,需要的朋友可以参考下
  • 接口文档对前后端开发人员非常重要,swagger 是基于open api规范构建开源工具,

swagger组件有
swagger editor 基于浏览器编辑器,
swagger ui 可视化ui展示描述文件 ,
swagger inspector 和ui组件很像,可以返回更多信息,会保存请求实际参数,
spring fox 是可以根据代码生成接口文档,所以描述文件是根据项目来变化的,不用手动更新,
springboot导入spring-fox依赖就是导入了wagger,
在启动类上添加@EnableSwagger2注解,添加这个注解后表示启动项目就会启动swagger组件,对当前项目全部控制器进行扫描,
访问swagger-ui
启动项目后在浏览器中输入 http://ip:port/swagger-ui.html
在swagger-ui中可视化操作项目接口,

  • swagger配置

可以在项目中创建SwaggerConfig 配置对象来进行配置文档内容
Docket对象 通过这个对象配置描述文件信息
通过apis()方法来设置哪些包中的内容被扫描,

  • 常用注解

@Api
是类上注解 控制了整个类生成接口信息的内容,属性tags 类的名字 description描述
@ApiOperation 写在方法上的注解,对方法进行描述, 属性value 方法描述 notes 提示信息
@ApiParam 写在方法参数中的注解,用于对参数进行描述,说明一下是否是必填项,属性有 name 参数名字 value参数描述 required是否是必须
@ApiModel是类上注解,主要应用在实体类上,属性value 类名称,description 是描述
@ApiModelproperty可以应用在方法上或是属性上,用于方法参数是应用类型时进行定义描述
@Apilgnore 用于类上方法上参数上,表示被忽视,

  • 前后端分离

一般使用vue+springboot
后端:后端控制层 服务层 数据访问层
前端:前端控制层 视图层
前后端交互 API
创建springboot项目 导入对应的依赖

在这里插入图片描述

启动swagger界面查看

在这里插入图片描述

配置swagger
swagger有自己的配置实例对象 Docket
这个对象方法中有多个属性
apiinfo属性是配置swagger显示的信息
select()配置扫描接口
groupname()配置api文档的分组 配置多个Docket实例可以实现多个分组,多个@bean

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

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

相关文章

  • Java使用CountDownLatch实现网络同步请求的示例代码

    Java使用CountDownLatch实现网络同步请求的示例代码

    CountDownLatch 是一个同步工具类,用来协调多个线程之间的同步,它能够使一个线程在等待另外一些线程完成各自工作之后,再继续执行。被将利用CountDownLatch实现网络同步请求,异步同时获取商品信息组装,感兴趣的可以了解一下
    2023-01-01
  • 详解Java语言中的抽象类与继承

    详解Java语言中的抽象类与继承

    这篇文章主要为大家详细介绍了Java语言中的抽象类与继承的相关资料,文中的示例代码讲解详细,对我们学习Java有一定的帮助,感兴趣的小伙伴快跟随小编一起了解一下
    2022-10-10
  • java的equals和==的比较示例

    java的equals和==的比较示例

    这篇文章主要介绍了java的equals和==的比较示例,需要的朋友可以参考下
    2014-04-04
  • springboot对数据库密码加密的实现

    springboot对数据库密码加密的实现

    这篇文章主要介绍了springboot对数据库密码加密的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • Java中Lambda表达式使用详细解读

    Java中Lambda表达式使用详细解读

    这篇文章主要介绍了Java中Lambda表达式使用及详解,lambda运行将函数作为一个方法的参数,也就是函数作为参数传递到方法中,使用lambda表达式可以让代码更加简洁,需要的朋友可以参考下
    2023-04-04
  • 在Eclipse中部署Spring Boot/Spring Cloud应用到阿里云

    在Eclipse中部署Spring Boot/Spring Cloud应用到阿里云

    这篇文章主要介绍了在Eclipse中部署Spring Boot/Spring Cloud应用到阿里云,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12
  • 深入学习Java 动态代理

    深入学习Java 动态代理

    Java 动态代理机制的出现,使得 Java 开发人员不用手工编写代理类,只要简单地指定一组接口及委托类对象,便能动态地获得代理类。下面小编和大家来一起学习一下吧
    2019-05-05
  • Springboot项目的Mapper中增加一个新的sql语句

    Springboot项目的Mapper中增加一个新的sql语句

    本文主要介绍了Springboot项目的Mapper中增加一个新的sql语句,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-05-05
  • java中的export方法实现导出excel文件

    java中的export方法实现导出excel文件

    这篇文章主要介绍了java中的export方法实现导出excel文件,文章围绕java导出excel文件的相关资料展开详细内容,需要的小伙伴可以参考一下
    2022-03-03
  • 自定义Jackson的ObjectMapper如何实现@ResponseBody的自定义渲染

    自定义Jackson的ObjectMapper如何实现@ResponseBody的自定义渲染

    这篇文章主要介绍了自定义Jackson的ObjectMapper如何实现@ResponseBody的自定义渲染,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-07-07

最新评论