快捷導(dǎo)航

SpringBoot3.x整合Knife4j接口文檔

更新時(shí)間：2025年06月29日 11:17:39 作者：木子空間Pro

SpringBoot整合Knife4j來生成和展示接口文檔是一種流行的做法,特別是在需要提供RESTful API文檔時(shí),下面就來介紹一下如何實(shí)現(xiàn),具有一定的參考價(jià)值,感興趣的可以了解一下

1.依賴

<!--        接口文檔，訪問地址：ip:port/doc.html-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>4.4.0</version>
</dependency>

2.配置

package com.base.config;

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {

    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("接口文檔標(biāo)題")
                        .version("1.0.0")
                        .description("接口描述")
                        .contact(new Contact().name("開發(fā)者").email("dev@example.com"))
                        .license(new License().name("Apache 2.0").url("https://www.apache.org/licenses/LICENSE-2.0.html"))
                )
                .externalDocs(new ExternalDocumentation()
                        .description("項(xiàng)目主頁")
                        .url("https://github.com/xxx/xxx"));
    }
}

3.用法細(xì)節(jié)

如果不想全部controller都掃描到，可以用@Hidden注解隱藏不顯示
在controller類名上加@Tag(name = "xxx")，具體方法名加@Operation(summary = "xxx")
配置文檔需登錄后訪問

在application.yml配置如下：

knife4j:
  enable: true
  basic:
    enable: true
    username: xxx
    password: xxx

原UI頁面顯示

在application.yml配置如下：

springdoc:
  swagger-ui:
#    訪問原UI界面：ip:port/swagger-ui/index.html
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      packages-to-scan: com.base.controller

附錄：可能會(huì)遇到問題

問題1

控制臺(tái)提示favicon.ico未找到

org.springframework.web.servlet.resource.NoResourceFoundException: No static resource favicon.ico.
	at org.springframework.web.servlet.resource.ResourceHttpRequestHandler.handleRequest(ResourceHttpRequestHandler.java:585)
	at

解決1

加一個(gè) favicon.ico 到 static/ 目錄。（如果你不關(guān)心這個(gè) favicon，可以忽略這個(gè)異常）

問題2

控制臺(tái)提示.well-known/appspecific/com.chrome.devtools.json未找到

2025-06-28T10:40:49.872+08:00  WARN 9924 --- [nio-8888-exec-4] .m.m.a.ExceptionHandlerExceptionResolver : Resolved [org.springframework.web.servlet.resource.NoResourceFoundException: No static resource .well-known/appspecific/com.chrome.devtools.json.]
org.springframework.web.servlet.resource.NoResourceFoundException: No static resource .well-known/appspecific/com.chrome.devtools.json.
	at org.sprin

解決2

攔截 .well-known/ 路徑，返回空響應(yīng)或 404（推薦給控制臺(tái)干凈控）

@RestController
public class WellKnownController {
    @RequestMapping("/.well-known/**")
    public ResponseEntity<Void> handleUnknownWellKnown() {
        return ResponseEntity.notFound().build(); // 返回 404，或改為返回 204 無內(nèi)容
    }
}

到此這篇關(guān)于SpringBoot3.x整合Knife4j接口文檔的文章就介紹到這了,更多相關(guān)SpringBoot3.x整合Knife4j內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: