脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → 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快速将Web中表格转换成Excel的方法

    使用Java快速将Web中表格转换成Excel的方法

    在平时做系统项目时,经常会需要做导出功能,下面这篇文章主要给大家介绍了关于使用Java快速将Web中表格转换成Excel的相关资料,需要的朋友可以参考下
    2023-06-06
  • 详解mybatis中association和collection的column传入多个参数问题

    详解mybatis中association和collection的column传入多个参数问题

    这篇文章主要介绍了详解mybatis中association和collection的column传入多个参数问题，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • java实现合并单元格的同时并导出excel示例

    java实现合并单元格的同时并导出excel示例

    这篇文章主要给大家介绍了关于java实现合并单元格的同时并导出excel的相关资料，文中先进行了简单的介绍，之后给出了详细的示例代码，相信对大家具有一定的参考价值，需要的朋友们下面来一起看看吧。
    2017-03-03
  • 浅析Java8 中 Map 接口的新方法

    浅析Java8 中 Map 接口的新方法

    这篇文章主要介绍了Java8 中 Map 接口的新方法,本文通过代码实例给大家介绍的非常详细，具有一定的参考借鉴价值，需要的朋友可以参考下
    2019-10-10
  • Java springboot接口迅速上手,带你半小时极速入门

    Java springboot接口迅速上手,带你半小时极速入门

    这篇文章主要给大家介绍了关于SpringBoot实现API接口的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-09-09
  • spring Boot查询数据分页显示的方法实例

    spring Boot查询数据分页显示的方法实例

    这篇文章主要给大家介绍了关于spring Boot查询数据分页显示的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用spring Boot具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
    2020-08-08
  • 深入dom4j使用selectSingleNode方法报错分析

    深入dom4j使用selectSingleNode方法报错分析

    本篇文章是对dom4j使用selectSingleNode方法报错进行了详细的分析介绍，需要的朋友参考下
    2013-05-05
  • 利用Java实现解析网页中的内容

    利用Java实现解析网页中的内容

    这篇文章主要为大家详细介绍了如何利用Java语言做一个解析指定网址的网页内容小应用，文中的实现步骤讲解详细，感兴趣的可以尝试下
    2022-10-10
  • Java实现文件及文件夹的删除

    Java实现文件及文件夹的删除

    这篇文章主要为大家详细介绍了Java实现文件及文件夹的删除，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-06-06
  • Spring Boot集成MyBatis访问数据库的方法

    Spring Boot集成MyBatis访问数据库的方法

    这篇文章主要介绍了Spring Boot集成MyBatis访问数据库的方法,需要的朋友可以参考下
    2017-04-04

最新评论