springboot 集成 swagger-spring-boot-starter 生成后台接口文档

之前初步学习了，使用 swagger2 生成 接口文档，这次我们使用 swagger-spring-boot-starter 来生成接口文档

Swagger 是一款自动生成在线文档 + 接口调试的工具。在 WEB 开发中不可否认的是我们需要给客户端提供 API 接口，这个时候需要借助 postman 等工具 进行调试，用过这些工具的应该知道一个 POST 请求一堆参数是非常枯燥且烦人的事情，而 swagger 能帮助我们自动生成参数…

swagger-spring-boot-starter 是一款建立在swagger基础之上的工具包，利用SpringBoot自动装配的特性，简化了传统swagger的繁琐配置

项目结构

一、引入 pom 文件依赖

<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

		<!-- swagger 支持 springboot 的依赖-->
		<dependency>
			<groupId>com.battcn</groupId>
			<artifactId>swagger-spring-boot-starter</artifactId>
			<version>2.1.2-RELEASE</version>
		</dependency>

二、springboot 中配置 swagger

1、application.yml

spring:
  swagger:
#  开启 swagger
    enabled: true
#    接口文档标题
    title:  后台 API 接口开发文档
#    描述
    description:  API开发文档
#    版本
    version: v1.0-beta
    contact:
      name: wxw
#   对后台接口进行分组
    groups:
      login:
        base-package: com.wxw.springboot_swagger.loginController
        group-name: 登录模块
      test:
        base-package: com.wxw.springboot_swagger.testController
        group-name: 测试模块
      base:
        base-package: com.wxw.springboot_swagger.controller
        group-name: 基础模块
#   开启登录验证，并设置用户名、密码
    security:
      filter-plugin: true
      username: wxw
      password: 1234

    #全局参数,比如Token之类的验证信息可以全局话配置
#    global-operation-parameters:
#    -   description: 'token'
#        modelRef: 'string'
#        name: 'token'
#        parameter-type: 'header'
#        required: true

2、controller 接口中

@RestController
@RequestMapping("/test")
@Api(tags = "测试", description = "测试描述", value = "测试")
public class TestController {

    @GetMapping
    @ApiOperation(value = "测试", notes = "测试")
    public String test() {
        return "hello,swagger";
    }
}

三、启动项目，查看接口文档

1、查看启动日志，可以看到已经加载了 swagger 登录的 filter

2、访问： http://localhost:8080/swagger-ui.html#/

输入配置的用户名和密码，有点奇怪的是为什么密码会是明文。。。

3、接口文档页面

左侧就是 我们在配置文件里面配置好的分组，右侧就是 相关信息

我们可以用这个测试，调用我们写好的接口

还有更多功能就需要深入研究了
https://github.com/battcn/swagger-spring-boot

关注公众号查看更多资源