脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot结合swagger2生成接口文档

详解SpringBoot结合swagger2快速生成简单的接口文档

 更新时间：2019年05月12日 14:30:48   作者：穷则独善其身_达则兼济天下  
这篇文章主要介绍了详解SpringBoot结合swagger2快速生成简单的接口文档，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

1. pom.xml中加入依赖

    <dependency>
      <groupId>com.spring4all</groupId>
      <artifactId>swagger-spring-boot-starter</artifactId>
      <version>1.8.0.RELEASE</version>
    </dependency>

2. 在启动类（即带@SpringBootApplication这个注解的类）上添加@EnableSwagger2Doc注解

3. 在application.properties中配置如下

swagger.enabled=true
swagger.title=spring-boot-mybatis module api
swagger.description=Starter for swagger 2.x
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/pbw123/spring-boot-demo
swagger.contact.name=mqXu
swagger.contact.url=https://www.jianshu.com/u/2f60beddf923
swagger.contact.email=2635225112@qq.com
swagger.base-package=com.springboot.mybatis.controller
swagger.base-path=/**
swagger.exclude-path=/error, /ops/**

经我多次尝试application.properties中不加任何swagger配置也可生成文档进行正常测试

另一种用swagger自动生成文档的方式请前往

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • 贪心算法原理及在Java中的使用

    贪心算法原理及在Java中的使用

    我们可能在好多地方都会听到贪心算法这一概念，并且它的算法思想也比较简单就是说算法只保证局部最优，进而达到全局最优。但我们实际编程的过程中用的并不是很多，究其原因可能是贪心算法使用的条件比较苛刻，所要解决的问题必须满足贪心选择性质
    2021-05-05
  • spring中@Autowire和@Resource的区别在哪里(推荐)

    spring中@Autowire和@Resource的区别在哪里(推荐)

    这篇文章主要介绍了spring中@Autowire和@Resource的区别在哪里？本文结合实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2023-02-02
  • IDEA如何使用spring-Initializr快速搭建SpringBoot

    IDEA如何使用spring-Initializr快速搭建SpringBoot

    这篇文章主要介绍了IDEA如何使用spring-Initializr快速搭建SpringBoot问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • 深入了解MyBatis二级缓存

    深入了解MyBatis二级缓存

    今天小编就为大家分享一篇关于深入了解MyBatis二级缓存，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
    2018-12-12
  • resty client使用Java客户端来访问Api

    resty client使用Java客户端来访问Api

    这篇文章主要介绍了resty-client使用Java客户端来访问Api的验证权限，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步
    2022-03-03
  • 详解Java基础之封装

    详解Java基础之封装

    这篇文章主要为大家介绍了Java基础之封装，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助
    2022-01-01
  • JAVA实现301永久重定向方法

    JAVA实现301永久重定向方法

    本篇文章给大家总结了JAVA中实现永久重定向的方法以及详细代码，对此有需要的朋友可以参考学习下。
    2018-04-04
  • Java中的synchronized 优化方法之锁膨胀机制

    Java中的synchronized 优化方法之锁膨胀机制

    这篇文章主要介绍了Java中的synchronized 优化方法之锁膨胀机制，锁膨胀机制是提升 synchronized 性能最有利的方法之一，下面我们就来看看什么事锁膨胀及锁膨胀的各种细节
    2022-05-05
  • Spring MVC全局异常处理和单元测试_动力节点Java学院整理

    Spring MVC全局异常处理和单元测试_动力节点Java学院整理

    本篇文章主要介绍了Spring MVC全局异常处理和单元测试，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-08-08
  • Java垃圾回收之标记清除算法详解

    Java垃圾回收之标记清除算法详解

    今天小编就为大家分享一篇关于Java垃圾回收之标记清除算法详解，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
    2018-10-10

最新评论