天天看点

Spring Boot 整合 Swagger(knife4j)

1、创建一个Spring Boot 项目

2、配置Swagger

2.1、 pom文件引入

2.2、 SwaggerConfig文件配置信息

2.3、controller层

2.4、application.yml(或者是:application.properties)

2.5、项目入口文件加注释

2.6、运行项目使用Swagger调试接口

此步骤不进行详细描述;

Spring Boot 整合 Swagger(knife4j)
Spring Boot 整合 Swagger(knife4j)
Spring Boot 整合 Swagger(knife4j)
Spring Boot 整合 Swagger(knife4j)
Spring Boot 整合 Swagger(knife4j)

此文件所在地方只要在 src 文件夹下即可:

Spring Boot 整合 Swagger(knife4j)

代码:

上述代码可复制直接使用,其中唯一必须要改的便是 Swagger 需要扫描的 Controller 层的路径;

Spring Boot 整合 Swagger(knife4j)

此代码中只需要了解以下几个点即可:

@Api(value = “Swagger-module”, tags = “Swagger-module”) :代表的是模块名,在swagger平台中会以作为每个模块的名称

@ApiOperation(value = “测试”, notes = “随意传入一个字符串”):代表的是模块下的各个接口的名称;

另外需要注意的是,一般情况下如果模块下没有接口或者所有接口均没有添加swagger的接口注解,那么在swagger的调试平台中此模块也不会显示;

Spring Boot 整合 Swagger(knife4j)
Spring Boot 整合 Swagger(knife4j)

项目正常启动后在浏览器中输入:http://localhost:2021/doc.html#/home (上一步中的服务端口设定是多少,不要忘记把此地址的端口也要保持一致;),回车后会进入如下界面:

Spring Boot 整合 Swagger(knife4j)

如此情况即算是Swagger已经配置好了,下面调试一下接口试试;

打开自定义的模块名,找到其下的接口,如下所示:

Spring Boot 整合 Swagger(knife4j)

点击 测试 接口中 调试 按钮,并在 id 参数栏中输入任意字符串后点击 发送 会得到如下所示的数据:

Spring Boot 整合 Swagger(knife4j)

说明接口调用成功并成功返回了传入数据的MD5加密后的数据,因此,调试成功;

继续阅读