1.引入项目依赖
<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId><version>4.5.0</version> </dependency>
2.新增配置文件
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 org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
public class OpenApiConfig {@Beanpublic OpenAPI springShopOpenAPI() {return new OpenAPI()// 接口文档标题.info(new Info().title("API接口文档")// 接口文档简介.description("这是基于Knife4j OpenApi3的接口文档")// 接口文档版本.version("v1.0")// 开发者联系方式.contact(new Contact().name("xxx").email("xxx@qq.com"))).externalDocs(new ExternalDocumentation().description("SpringBoot基础框架").url("http://127.0.0.1:8081"));}}
3.bootstrap.yml配置文件
server:port: 8081 springdoc:swagger-ui:path: /swagger-ui.htmltags-sorter: alphaoperations-sorter: alphaapi-docs:enabled: truepath: /v3/api-docs # knife4j的增强配置，不需要增强可以不配 knife4j:enable: true# 开启Swagger的Basic认证功能,默认是falsebasic:enable: true# Basic认证用户名username: admin# Basic认证密码password: 123456setting:language: zh_cn#生产环境屏蔽production: false
4.启动后访问：localhost:8081/doc.html
