SpringBoot Knife4j框架&Knife4j的显示内容的配置方式_Java

knife4j框架

knife4j框架是一款国人开发的、基于swagger 2的在线api文档框架。

knife4j框架的一些主要作用和特点：

自动生成api文档：knife4j可以根据代码中的注解和配置信息，自动生成api接口文档。开发者只需要在代码中添加相关注解，就能够生成详细的api文档，包括接口描述、请求参数、响应结果等信息。
接口文档展示：knife4j生成的api文档以用户友好的方式展示，包括接口列表、接口详情、请求示例、参数说明等。开发者可以通过浏览器访问api文档，方便查阅和理解接口的使用方式。
接口测试工具：knife4j提供了接口测试工具，可以直接在文档界面进行接口测试，无需额外的接口测试工具。开发者可以通过输入参数、发送请求，并查看响应结果，方便调试和验证接口的正确性。
接口权限控制：knife4j支持对api接口进行权限控制，可以配置接口的访问权限，限制某些接口只能被特定的角色或用户访问。
接口在线调试：knife4j提供了在线调试功能，可以在文档界面直接发送请求并查看响应结果，方便开发者进行接口的调试和验证。

使用

knife4j的简单使用只需要3步：

添加依赖：

knife4j-spring-boot-starter，版本2.0.9

注意：建议使用spring boot 2.5.x版本，如果使用更高版的spring boot，knife4j的版本也需要提高

<knife4j-spring-boot.version>2.0.9</knife4j-spring-boot.version>

<!-- knife4j spring boot：在线api文档 -->
<dependency>
    <groupid>com.github.xiaoymin</groupid>
    <artifactid>knife4j-spring-boot-starter</artifactid>
    <version>${knife4j-spring-boot.version}</version>
</dependency>

添加配置：

在配置文件中添加knife4j.enable属性的配置，取值为true

添加配置类：类的代码相对固定

检查配置controller包的属性值是否与你的项目相符合

package cn.tedu.csmall.product.config;

import com.github.xiaoymin.knife4j.spring.extension.openapiextensionresolver;
import lombok.extern.slf4j.slf4j;
import org.springframework.beans.factory.annotation.autowired;
import org.springframework.context.annotation.bean;
import org.springframework.context.annotation.configuration;
import springfox.documentation.builders.apiinfobuilder;
import springfox.documentation.builders.pathselectors;
import springfox.documentation.builders.requesthandlerselectors;
import springfox.documentation.service.apiinfo;
import springfox.documentation.service.contact;
import springfox.documentation.spi.documentationtype;
import springfox.documentation.spring.web.plugins.docket;
import springfox.documentation.swagger2.annotations.enableswagger2webmvc;

/**
 * knife4j配置类
 *
 * @author java@tedu.cn
 * @version 0.0.1
 */
@slf4j
@configuration
@enableswagger2webmvc
public class knife4jconfiguration {

    /**
     * 【重要】指定controller包路径
     */
    private string basepackage = "cn.tedu.csmall.product.controller";
    /**
     * 分组名称
     */
    private string groupname = "product";
    /**
     * 主机名
     */
    private string host = "http://java.tedu.cn";
    /**
     * 标题
     */
    private string title = "酷鲨商城在线api文档--商品管理";
    /**
     * 简介
     */
    private string description = "酷鲨商城在线api文档--商品管理";
    /**
     * 服务条款url
     */
    private string termsofserviceurl = "http://www.apache.org/licenses/license-2.0";
    /**
     * 联系人
     */
    private string contactname = "java教学研发部";
    /**
     * 联系网址
     */
    private string contacturl = "http://java.tedu.cn";
    /**
     * 联系邮箱
     */
    private string contactemail = "java@tedu.cn";
    /**
     * 版本号
     */
    private string version = "1.0.0";

    @autowired
    private openapiextensionresolver openapiextensionresolver;

    public knife4jconfiguration() {
        log.debug("创建配置类对象：knife4jconfiguration");
    }

    @bean
    public docket docket() {
        string groupname = "1.0.0";
        docket docket = new docket(documentationtype.swagger_2)
                .host(host)
                .apiinfo(apiinfo())
                .groupname(groupname)
                .select()
                .apis(requesthandlerselectors.basepackage(basepackage))
                .paths(pathselectors.any())
                .build()
                .extensions(openapiextensionresolver.buildextensions(groupname));
        return docket;
    }

    private apiinfo apiinfo() {
        return new apiinfobuilder()
                .title(title)
                .description(description)
                .termsofserviceurl(termsofserviceurl)
                .contact(new contact(contactname, contacturl, contactemail))
                .version(version)
                .build();
    }
}

完成后，可以通过 /doc.html 来访问api文档，即在浏览器的地址栏中输入网址：http://localhost:8080/doc.html

访问

knife4j的显示内容的配置

@api：添加在控制器类上，通过此注解的tags属性，可以配置模块名称（显示在api文档左侧目录中的名称）

提示：当存在多个控制器时，显示的顺序是根据配置的模块名称来决定的，如果需要自行指定顺序，建议在各模块名称前添加数字编号

例如：

@restcontroller
@requestmapping("/album")
@api(tags = "04. 相册管理模块")
public class albumcontroller {
}

@apioperation：添加在处理请求的方法上，通过此注解的value属性，可以配置业务功能名称
@apioperationsupport：添加在处理请求的方法上，通过此注解的order属性（int类型），可以配置业务功能的排序序号，将升序排列

例如：

@postmapping("/delete")
@apioperation("根据id删除相册")
@apioperationsupport(order = 200)
public string delete() {
    // ...
}

@apimodelproperty：添加在封装的请求参数的属性上，通过此注解的value属性，可以配置请求参数的描述信息，通过此注解的required属性，可以配置是否必须提交此参数（此配置只是一种显示效果，并不具备真正的检查功能），通过此注解的example属性，可以配置示例值，(示例值不是说明是举例,要满足属性类型,如果在排序integer 输入字符串会报错)例如：

@data
public class albumaddnewparam implements serializable {

    @apimodelproperty(value = "相册名称", required = true, example = "可乐的相册")
    private string name;

    @apimodelproperty(value = "相册简介", required = true, example = "可乐的相册的简介")
    private string description;

    @apimodelproperty(value = "排序序号，必须是1~255之间的数字", required = true, example = "97")
    private integer sort;

}

@apiignore：添加在请求参数上，表示api文档将忽略此请求参数

@postmapping("/add-new")
@apioperation("添加相册")
@apioperationsupport(order = 100)
public string addnew(albumaddnewparam albumaddnewparam, 
                     @apiignore httpsession session) {
    // ...
}

@apiimplicitparam：添加在处理请求的方法上，用于对未封装的请求参数进行描述，注意，此注解必须配置name属性，取值为方法的参数名，然后，结合此注解的value属性对参数进行描述，此注解还有与@apimodelproperty相同的一些属性，例如required、example等，还可以通过datatype指定数据类型
@apiimplicitparams：添加在处理请求的方法上，当有多个@apiimplictparam需要被配置时，应该将它们作为当前@apiimplicitparams的属性值

例如：

@postmapping("/delete")
@apioperation("根据id删除相册")
@apioperationsupport(order = 200)
@apiimplicitparams({
        @apiimplicitparam(name = "albumid", value = "相册id", required = true, datatype = "long"),
        @apiimplicitparam(name = "userid", value = "用户id", required = true, datatype = "long")
})
public string delete(long albumid, long userid) {
    // ...
}