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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • springboot+Quartz实现任务调度的示例代码

    springboot+Quartz实现任务调度的示例代码

    本篇文章主要介绍了springboot + Quartz 实现任务调度的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-02-02
  • Mybatis-plus如何在xml中传入自定义的SQL语句

    Mybatis-plus如何在xml中传入自定义的SQL语句

    这篇文章主要介绍了Mybatis-plus如何在xml中传入自定义的SQL语句问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • Java NIO Buffer实现原理详解

    Java NIO Buffer实现原理详解

    本篇文章主要对NIO核心三件套:缓冲区(Buffer)、选择器 (Selector)和通道(Channel),其中之一的缓冲区Buffer实现原理的学习总结。感兴趣的小伙伴可以了解一下
    2021-11-11
  • 详解java各种集合的线程安全

    详解java各种集合的线程安全

    这篇文章主要介绍了详解java各种集合的线程安全,小编觉得挺不错的,这里分享给大家,供需要的朋友参考。
    2017-10-10
  • 浅谈StringEntity 和 UrlEncodedFormEntity之间的区别

    浅谈StringEntity 和 UrlEncodedFormEntity之间的区别

    这篇文章主要介绍了StringEntity 和 UrlEncodedFormEntity之间的区别,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • 关于JDBC的简单封装(实例讲解)

    关于JDBC的简单封装(实例讲解)

    下面小编就为大家带来一篇关于JDBC的简单封装(实例讲解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • JAVA模拟新增顺序表及单链表

    JAVA模拟新增顺序表及单链表

    这篇文章主要介绍了JAVA模拟新增顺序表及单链表,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • 详解Java token主流框架之JWT

    详解Java token主流框架之JWT

    JWT(JSON Web Token)是一种基于JSON格式的轻量级的、用于身份认证的开放标准,它通过在用户和服务器之间传递一个安全的、可靠的、独立的JSON对象来进行身份验证和授权,本文将详细给大家介绍Java token主流框架之JWT,需要的朋友可以参考下
    2023-05-05
  • 利用Java如何获取IP与机器名方法示例

    利用Java如何获取IP与机器名方法示例

    在开发工作中,我们常常需要获取客户端的IP。下面这篇文章主要给大家介绍了关于利用Java如何获取IP与机器名的相关资料,文中通过示例代码介绍的非常详细,对大家具有一定的参考学习价值,需要的朋友们下面来一起看看吧。
    2017-07-07
  • java多线程编程之向线程传递数据的三种方法

    java多线程编程之向线程传递数据的三种方法

    在多线程的异步开发模式下,数据的传递和返回和同步开发模式有很大的区别。由于线程的运行和结束是不可预料的,因此,在传递和返回数据时就无法象函数一样通过函数参数和return语句来返回数据
    2014-01-01

最新评论