基于SpringBoot3从零配置SpringDoc
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springdoc.core.GroupedOpenApi;
@Configuration
public class SpringDocConfig {
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.info(new Info()
.title("示例API文档")
.version("v0.0.1")
.license(new License().name("Apache 2.0").url("http://springdoc.org")));
}
@Bean
public GroupedOpenApi publicApi() {
return GroupedOpenApi.builder()
.group("public-api")
.pathsToMatch("/api/v1/**")
.build();
}
@Bean
public GroupedOpenApi privateApi() {
return GroupedOpenApi.builder()
.group("private-api")
.pathsToMatch("/api/v1/secure/**")
.build();
}
}
这个配置类定义了两个GroupedOpenApi beans,分别用于路径/api/v1/**
和/api/v1/secure/**
下的API。这样,不同路径下的API可以被分配到不同的分组中,在生成的Swagger UI中以不同的标签显示。这种配置可以帮助开发者更好地管理和维护他们的API文档。
评论已关闭