摘要: 本篇文章主要介绍我在SpringBoot项目中使用Swagger的基础步骤、体会和异常error解决。
一、Swagger概述
概念:Swagger是一个SpringBoot依赖,是一个接口文档生成工具。
作用:能够把Controller暴露的API展示为一个HTML文档,这个文档会根据Controller中的代码和注释实时更新。
现实中解决的问题是:增加前后端分离的协同性。让接口文档 规范化、实时更新、由程序自动生成而不必多花费时间和经历去写。
二、Swagger基本使用
配置信息如下:
操作系统:Windows10
JDK版本:1.8
集成开发环境:IDEA
Maven版本:3.8.1
SpringBoot版本:2.5.8(最好使用这个版本,不然需要额外解决很多琐事,不利于使用)
springfox-swagger-ui和springfox-swagger2版本:3.0.0
1、添加Swagger依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
Swagger3.0版本不需要配置