相信很多人都用过postman,使用postman其实可以很简便的进行接口调试,但是呢,每次还要写url,以及要添加参数名字(很容易写错)。所以啊,swagger2优势就体现出来了,它只需要添加少量注解即可在项目下调试接口,并且可以根据项目是否是测试还是生产环境,可以显示或禁止页面接口调试,介绍就到这里,开始写整合部分。
一.maven添加依赖
此处使用的是2.7.0版本,下面的ui二选一即可,springfox-swagger-ui是官方提供的UI界面(本人一直使用的是这个),swagger-bootstrap-ui是基于左右菜单风格,GitHub项目地址:GitHub - xiaoymin/swagger-bootstrap-ui: Knife4j is a set of Swagger2 and OpenAPI3 All-in-one enhancement solution
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<!--springfox-swagger-ui http://localhost:8010/swagger-ui.html-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
<!--bootstap-ui http://localhost:8010/doc.html-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.6</version>
</dependency>
二.swagger2配置文件
本人喜欢将swagger2一些参数写到配置文件中,方便以后修改,也可以将其写死。在application.yml中添加以下配置。enable为true是表示在swagger-ui.html中显示接口。
swagger:
enable: true
info:
version: 0.1
title: 兮川项目的接口
description: 薛定谔的猫,你不去验证,就无法知道真假