在knife4j文档中并没有看到4.x版本该如何对swaggerConfig进行配置(配置作者,接口文档名称等),故编写此文以帮助更多的人。
废话少说,直接上代码
package com.lackoxy.wetop.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 lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
/**
* @projectName: wetop
* @package: com.lackoxy.wetop.config
* @className: SwaggerConfig
* @author: lackoxy
* @description:
* @date: 2024/4/19 16:05
*/
@Configuration
@Slf4j
public class SwaggerConfig {
//配置开源协议
// private License license() {
// return new License()
// .name("MIT") //开源协议种类
// .url("https://opensource.org/licenses/MIT");
// }
private Info info(){
return new Info()
.title("xxx接口文档") //接口文档名称
.description("xxx的接口文档") //描述
.version("v0.1") //项目版本
.contact(new Contact()
.name("作者") //作者
.url("github主页地址") //作者网址,可填写你的github主页
.email("email")); //邮箱
// .license(license()); //开源协议
}
//额外信息配置 可配可不配
private ExternalDocumentation externalDocumentation() {
return new ExternalDocumentation()
.description("代码仓库地址")
.url("xxxx");
}
@Bean
public OpenAPI springShopOpenAPI() {
return new OpenAPI()
.info(info())
.externalDocs(externalDocumentation());
}
}