后台管理系统的通用权限解决方案(三)SpringBoot整合Knife4j生成接口文档

最新推荐文章于 2025-06-05 10:55:11 发布

维先生d

最新推荐文章于 2025-06-05 10:55:11 发布

阅读量509

点赞数 9

CC 4.0 BY-SA版权

分类专栏：后台管理系统的通用权限解决方案文章标签： spring boot 后端 java Knife4j 接口文档

本文链接：https://blog.youkuaiyun.com/weixin_42739799/article/details/143264962

1 Knife4j介绍

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案，前身是swagger-bootstrap-ui，取名knife4j是希望它能像一把匕首一样小巧，轻量，并且功能强悍！

其底层是对Springfox的封装，使用方式也和Springfox一致，只是对接口文档UI进行了优化。其核心功能包括文档说明和在线调试。

2 Knife4j案例

1）创建maven工程``，并配置其pom.xml文件如下

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/>
    </parent>
    <groupId>com.hsgx</groupId>
    <artifactId>knife4j-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--knife4j-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.1</version>
        </dependency>
    </dependencies>
</project>

2）创建实体类User和控制器UserController类，跟Springfox的写法是一样的

package com.hsgx.pojo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

@Data
@ApiModel(description = "用户实体")
public class User {
   
   
    @ApiModelProperty(value =<