集成SPRINGDOCOPENAPI的微服务实践-springcloud入门教程.pdf

集集成成SPRINGDOCOPENAPI的的微微服服务务实实践践-springcloud⼊⼊门门教教程程 在⽂章中我们学习了使⽤swagger2来⽣成微服务的⽂档⽅法。但SpringFox 库 重要的问题是缺乏对 新版本 3 中的 OpenA PI 和 Spring 的⽀持使⽤ WebFlux 构建的反应式 A PI。所有这些特性都是由Springdoc OpenA PI 库实现的。因此，它可能会取代 SpringFox 作为 Swagger 和⽤于 Spring Boot 应⽤程序的 OpenA PI 3 ⽣成⼯具。 例例⼦⼦ 作为本⽂中的代码⽰例，我们将使⽤使⽤ Spring Cloud 构建的典型微服务架构。它由 Spring Cloud Config Server、 ureka 发现和作为 A PI ⽹关的 Spring Cloud Gateway 组成。我们还有三个微服务，外部客户端只能通过⽹关才能访问它们暴露 R ST A PI 。下图显⽰了本⽂所提 及的系统简单架构图。 执执⾏⾏ 与 Springdoc OpenA PI 库相关的第⼀个好消息是它可以与 SpringFox 库⼀起存在⽽不会发⽣任何冲突。如果有⼈使⽤您的 Swagger ⽂ 档，要为基于标准 Spring MVC 的应⽤程序启⽤ Springdoc，您需要将以下依赖项包含到 Maven 中pom.x ml。 1 dependency 2 groupIdorg.springdoc/groupId 3 artifact Idspringdoc-openapi-webmvc-core/artifact Id 4 version1.2.32/version /dependency 5 我们的每个 Spring Boot 微服务都构建在 Spring MVC 之上，并为标准同步 R ST 通信提供端点。但是，构建在 Spring Cloud Gateway 之 上的 A PI ⽹关使⽤ Netty 作为嵌⼊式服务器，并基于响应式 Spring WebFlux。它还提供 Swagger UI 以访问所有微服务公开的⽂档，因此它 必须包含启⽤ UI 的库。必须包含以下两个库才能为基于 Spring WebFlux 的响应式应⽤程序启⽤ Springdoc ⽀持。 1 2 dependency 3 groupIdorg.springdoc/groupId artifact Idspringdoc-openapi-webflux-core/artifact Id 4 version1.2.31/version 5 /dependency 6 dependency 7 groupIdorg.springdoc/groupId artifact Idspringdoc-openapi-webflux-ui/artifact Id 8 version1.2.31/version 9 /dependency 10 我们可以通过在 Spring Boot 配置⽂件中设置属性或使⽤@Beans . 例如，我们不想为应⽤程序公开的所有 HTTP 端点 （如 Spring 特定端点） ⽣成 OpenA PI 清单，因此我们可以定义⼀个基本包属性⽤于扫描，如下所⽰。在我们的源代码⽰例中，每个应⽤程序 YAML 配置⽂件都位 于config-service模块中。 1springdoc : 2 packagesToScan: pl.piomin.serv ices .department 这是员⼯服务的主要类。我们使⽤@OpenA PIDefinition注释来定义 Swagger 站点上显⽰的应⽤程序的描述。如您所见，我们仍然可以使 ⽤@ nableSwagger2. 1 2 @SpringBootApplication @ nableDiscoveryClient 3 @ nableSwagger2 4 @OpenA PIDefinition(info = 5 @Info(title = mployee A PI, version = 1.0, description = Documentation m