<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
<version>4.3.0</version>
</dependency>
- 在application.yml配置文件中新增如下配置(使用新版不需要创建配置文件)
- 注意写到 配置文件 的dev分支下,这样线上环境就屏蔽掉了接口文档
knife4j:
enable: true #开启接口文档
openapi:
title: "用户管理系统接口文档" #文档标题
description: "用户管理系统接口文档" #文档描述
email: novices666@gmail.com
concat: Novices #作者
url: https://github.com/Novices666/ #
version: v4.0 #版本
group: #分组
user-control:
group-name: 用户管理 #组名
api-rule: package #api生成规则 package 按包 annotation 按注解
api-rule-resources:
- cc.novices.usercontrol.controller #规则资源
- 访问
http://localhost:8080/api/doc.html
即可