IDEA SpringBoot 项目配置Swagger2的详细教程

 更新时间:2020年11月03日 10:26:00   作者:极光稻草人  
这篇文章主要介绍了IDEA SpringBoot 项目配置Swagger2的详细教程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
  • 原先前后端分离的api文档开启了前后端相互撕逼的对接之路
  • api更新不及时导致对接失败,以及存在测试不够方便,而swagger则很好的解决了这个问题

在项目中也经常用到swagger2,于是动手记录一下swagger2配置过程,希望能带来一点帮助。

在SpringBoot项目当中使用Swagger主要分为以下几步:

1、SpringBoot-web项目并添加pom.xml依赖

2、编写HelloController,测试成功运行

3、创建一个SwaggerConfig类,配置swagger-ui

流程确实是很简单的,但是能真正的在项目中活用swagger却不是那么简单

1、SpringBoot-web项目并添加pom.xml依赖

可以直接在maven repository搜索

多最一句,一般在选择maven依赖时,我们趋向于选择最稳定版本,可以通过Usages判断,尽量不要选择最新版,及时并没有什么影响。详细经历过版本冲突和版本不兼容的小伙伴应该深有体会。

在这里插入图片描述

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.9.2</version>
</dependency>

2、编写HelloController,测试成功运行

package cn.swpu.myblog.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
@Api(tags = "测试-HelloWorld") //这个controller下的所有接口的描述
public class HelloController {

  @ApiOperation("测试Swagger2") //显示在接口的信息说明
  @RequestMapping(value = "/test", method = RequestMethod.GET) //请求路径和类型
  public void testSwagger(){

  }
}

3、创建一个SwaggerConfig类,配置swagger-ui

package cn.swpu.myblog.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
}

然后就可以根据你的端口访问swagger-ui了,例如我的是8099

http://localhost:8099/swagger-ui.html#/

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

至此IDEA 继承Swagger就可以了,但这仅仅只是个开始,swagger还是有很多的实用技巧。

到此这篇关于IDEA SpringBoot 项目配置Swagger2的详细教程的文章就介绍到这了,更多相关IDEA SpringBoot 项目配置Swagger2内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java黑盒测试之nextDate函数测试

    Java黑盒测试之nextDate函数测试

    这篇文章主要介绍了Java黑盒测试之nextDate函数测试,文中有非常详细的代码示例,对正在学习Java黑盒测试的小伙伴们有很大的帮助哦,需要的朋友可以参考下
    2021-05-05
  • Java由浅入深讲解继承下

    Java由浅入深讲解继承下

    继承就是可以直接使用前辈的属性和方法。自然界如果没有继承,那一切都是处于混沌状态。多态是同一个行为具有多个不同表现形式或形态的能力。多态就是同一个接口,使用不同的实例而执行不同操作
    2022-04-04
  • Java POI导出Excel时合并单元格没有边框的问题解决

    Java POI导出Excel时合并单元格没有边框的问题解决

    这篇文章主要给大家介绍了关于Java POI导出Excel时合并单元格没有边框的问题解决办法,文中通过代码介绍的非常详细,对大家学习或者使用java具有一定的参考学习价值,需要的朋友可以参考下
    2023-07-07
  • MybatisPlus自带的queryWrapper实现时间倒序方式

    MybatisPlus自带的queryWrapper实现时间倒序方式

    这篇文章主要介绍了MybatisPlus自带的queryWrapper实现时间倒序方式,具有很好的参考价值,希望对的有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • gateway和jwt网关认证实现过程解析

    gateway和jwt网关认证实现过程解析

    这篇文章主要介绍了gateway和jwt网关认证实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • 如何利用Map与函数式接口来实现去除if else

    如何利用Map与函数式接口来实现去除if else

    这篇文章主要介绍了如何利用Map与函数式接口来实现去除if else问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • 如何通过idea实现springboot集成mybatis

    如何通过idea实现springboot集成mybatis

    这篇文章主要介绍了如何通过idea实现springboot集成mybatis,使用springboot 集成 mybatis后,通过http请求接口,使得通过http请求可以直接操作数据库,本文结合实例代码给大家介绍的非常详细,需要的朋友可以参考下
    2023-09-09
  • 如何正确控制springboot中bean的加载顺序小结篇

    如何正确控制springboot中bean的加载顺序小结篇

    这篇文章主要介绍了如何正确控制springboot中bean的加载顺序总结,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • Java中如何将String转JSONObject

    Java中如何将String转JSONObject

    这篇文章主要介绍了Java中如何将String转JSONObject,String类型转JSONObject,下面有两种方式可以进行转换,本文结合实例代码给大家介绍的非常详细,需要的朋友可以参考下
    2023-05-05
  • Mybatis关联查询结果集对象嵌套的具体使用

    Mybatis关联查询结果集对象嵌套的具体使用

    在查询时经常出现一对多”的关系,所有会出现嵌套对象的情况,本文主要介绍了Mybatis关联查询结果集对象嵌套的具体使用,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-02-02

最新评论