在Spring Cloud项目中集成Springdoc OpenAPI生成OpenAPI 3文档的详细解析
import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class OpenApiConfig {
@Bean
public GroupedOpenApi publicApi() {
return GroupedOpenApi.builder()
.group("order-service")
.pathsToMatch("/order/**")
.build();
}
@Bean
public GroupedOpenApi privateApi() {
return GroupedOpenApi.builder()
.group("user-service")
.pathsToMatch("/user/**")
.build();
}
}
这个配置类定义了两个GroupedOpenApi
的Bean,分别用于对应两个服务组的API文档。/order/**
和 /user/**
是要包含在这些组中的路径模式。这样,Springdoc OpenAPI就会根据这些配置生成对应的API文档。这个例子展示了如何使用Springdoc OpenAPI进行有效的文档分组,这在构建大型微服务系统时非常有用。
评论已关闭