SpringBoot?Knife4j框架&Knife4j的顯示內(nèi)容的配置方式

更新時(shí)間：2024年09月27日 14:33:53 作者：萬(wàn)物更新_

Knife4j框架是基于Swagger2開(kāi)發(fā)的在線API文檔生成工具,主要功能包括自動(dòng)生成API文檔、接口文檔展示、接口測(cè)試工具、接口權(quán)限控制和在線調(diào)試,該框架支持通過(guò)注解自動(dòng)生成詳細(xì)的接口文檔,開(kāi)發(fā)者可以直接在文檔界面進(jìn)行接口測(cè)試和調(diào)試

Knife4j框架

Knife4j框架是一款國(guó)人開(kāi)發(fā)的、基于Swagger 2的在線API文檔框架。

Knife4j框架的一些主要作用和特點(diǎn)：

自動(dòng)生成API文檔：Knife4j可以根據(jù)代碼中的注解和配置信息，自動(dòng)生成API接口文檔。開(kāi)發(fā)者只需要在代碼中添加相關(guān)注解，就能夠生成詳細(xì)的API文檔，包括接口描述、請(qǐng)求參數(shù)、響應(yīng)結(jié)果等信息。
接口文檔展示：Knife4j生成的API文檔以用戶友好的方式展示，包括接口列表、接口詳情、請(qǐng)求示例、參數(shù)說(shuō)明等。開(kāi)發(fā)者可以通過(guò)瀏覽器訪問(wèn)API文檔，方便查閱和理解接口的使用方式。
接口測(cè)試工具：Knife4j提供了接口測(cè)試工具，可以直接在文檔界面進(jìn)行接口測(cè)試，無(wú)需額外的接口測(cè)試工具。開(kāi)發(fā)者可以通過(guò)輸入?yún)?shù)、發(fā)送請(qǐng)求，并查看響應(yīng)結(jié)果，方便調(diào)試和驗(yàn)證接口的正確性。
接口權(quán)限控制：Knife4j支持對(duì)API接口進(jìn)行權(quán)限控制，可以配置接口的訪問(wèn)權(quán)限，限制某些接口只能被特定的角色或用戶訪問(wèn)。
接口在線調(diào)試：Knife4j提供了在線調(diào)試功能，可以在文檔界面直接發(fā)送請(qǐng)求并查看響應(yīng)結(jié)果，方便開(kāi)發(fā)者進(jìn)行接口的調(diào)試和驗(yàn)證。

使用

Knife4j的簡(jiǎn)單使用只需要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

添加配置類(lèi)：類(lèi)的代碼相對(duì)固定

檢查配置Controller包的屬性值是否與你的項(xiàng)目相符合

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配置類(lèi)
 *
 * @author java@tedu.cn
 * @version 0.0.1
 */
@Slf4j
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    /**
     * 【重要】指定Controller包路徑
     */
    private String basePackage = "cn.tedu.csmall.product.controller";
    /**
     * 分組名稱(chēng)
     */
    private String groupName = "product";
    /**
     * 主機(jī)名
     */
    private String host = "http://java.tedu.cn";
    /**
     * 標(biāo)題
     */
    private String title = "酷鯊商城在線API文檔--商品管理";
    /**
     * 簡(jiǎn)介
     */
    private String description = "酷鯊商城在線API文檔--商品管理";
    /**
     * 服務(wù)條款URL
     */
    private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";
    /**
     * 聯(lián)系人
     */
    private String contactName = "Java教學(xué)研發(fā)部";
    /**
     * 聯(lián)系網(wǎng)址
     */
    private String contactUrl = "http://java.tedu.cn";
    /**
     * 聯(lián)系郵箱
     */
    private String contactEmail = "java@tedu.cn";
    /**
     * 版本號(hào)
     */
    private String version = "1.0.0";

    @Autowired
    private OpenApiExtensionResolver openApiExtensionResolver;

    public Knife4jConfiguration() {
        log.debug("創(chuàng)建配置類(lèi)對(duì)象：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();
    }
}

完成后，可以通過(guò) /doc.html 來(lái)訪問(wèn)API文檔，即在瀏覽器的地址欄中輸入網(wǎng)址：http://localhost:8080/doc.html

訪問(wèn)

Knife4j的顯示內(nèi)容的配置

@Api：添加在控制器類(lèi)上，通過(guò)此注解的tags屬性，可以配置模塊名稱(chēng)（顯示在API文檔左側(cè)目錄中的名稱(chēng)）

提示：當(dāng)存在多個(gè)控制器時(shí)，顯示的順序是根據(jù)配置的模塊名稱(chēng)來(lái)決定的，如果需要自行指定順序，建議在各模塊名稱(chēng)前添加數(shù)字編號(hào)

例如：

@RestController
@RequestMapping("/album")
@Api(tags = "04. 相冊(cè)管理模塊")
public class AlbumController {
}

@ApiOperation：添加在處理請(qǐng)求的方法上，通過(guò)此注解的value屬性，可以配置業(yè)務(wù)功能名稱(chēng)
@ApiOperationSupport：添加在處理請(qǐng)求的方法上，通過(guò)此注解的order屬性（int類(lèi)型），可以配置業(yè)務(wù)功能的排序序號(hào)，將升序排列

例如：

@PostMapping("/delete")
@ApiOperation("根據(jù)ID刪除相冊(cè)")
@ApiOperationSupport(order = 200)
public String delete() {
    // ...
}

@ApiModelProperty：添加在封裝的請(qǐng)求參數(shù)的屬性上，通過(guò)此注解的value屬性，可以配置請(qǐng)求參數(shù)的描述信息，通過(guò)此注解的required屬性，可以配置是否必須提交此參數(shù)（此配置只是一種顯示效果，并不具備真正的檢查功能），通過(guò)此注解的example屬性，可以配置示例值，(示例值不是說(shuō)明是舉例,要滿足屬性類(lèi)型,如果在排序Integer 輸入字符串會(huì)報(bào)錯(cuò))例如：

@Data
public class AlbumAddNewParam implements Serializable {

    @ApiModelProperty(value = "相冊(cè)名稱(chēng)", required = true, example = "可樂(lè)的相冊(cè)")
    private String name;

    @ApiModelProperty(value = "相冊(cè)簡(jiǎn)介", required = true, example = "可樂(lè)的相冊(cè)的簡(jiǎn)介")
    private String description;

    @ApiModelProperty(value = "排序序號(hào)，必須是1~255之間的數(shù)字", required = true, example = "97")
    private Integer sort;

}

@ApiIgnore：添加在請(qǐng)求參數(shù)上，表示API文檔將忽略此請(qǐng)求參數(shù)

@PostMapping("/add-new")
@ApiOperation("添加相冊(cè)")
@ApiOperationSupport(order = 100)
public String addNew(AlbumAddNewParam albumAddNewParam, 
                     @ApiIgnore HttpSession session) {
    // ...
}

@ApiImplicitParam：添加在處理請(qǐng)求的方法上，用于對(duì)未封裝的請(qǐng)求參數(shù)進(jìn)行描述，注意，此注解必須配置name屬性，取值為方法的參數(shù)名，然后，結(jié)合此注解的value屬性對(duì)參數(shù)進(jìn)行描述，此注解還有與@ApiModelProperty相同的一些屬性，例如required、example等，還可以通過(guò)dataType指定數(shù)據(jù)類(lèi)型
@ApiImplicitParams：添加在處理請(qǐng)求的方法上，當(dāng)有多個(gè)@ApiImplictParam需要被配置時(shí)，應(yīng)該將它們作為當(dāng)前@ApiImplicitParams的屬性值

例如：

@PostMapping("/delete")
@ApiOperation("根據(jù)ID刪除相冊(cè)")
@ApiOperationSupport(order = 200)
@ApiImplicitParams({
        @ApiImplicitParam(name = "albumId", value = "相冊(cè)ID", required = true, dataType = "long"),
        @ApiImplicitParam(name = "userId", value = "用戶ID", required = true, dataType = "long")
})
public String delete(Long albumId, Long userId) {
    // ...
}