在 openapi 文件中添加 helidon 对象健康和指标

Question

我正在为我的 helidon 项目中的服务编写带有 openapi 3.0 描述的文件openapi.yml 。 但我也使用标准的 helidon 处理程序（健康和指标）：

return Routing.builder()
   .register(JsonSupport.create())
   .register("/api/files", health)     
   .register("/api/files", metrics)    
   .register("/api/files/storage", fileService)
   .register("/api/files", OpenAPISupport.create(config))
   .build();

如何在我的 openapi.yml 中创建健康和指标部分？ 我用：

<dependency>
   <groupId>io.helidon.openapi</groupId>
   <artifactId>helidon-openapi</artifactId>
   <version>1.3.1</version>
</dependency>

Answer 1

有两种方法可以做到这一点：

1. 只需将/health和/metrics端点信息添加到您已经创建的openapi.yml文件中。
2. 将您自己的 MicroProfile OpenAPI OASModelReader接口实现添加到以编程方式添加运行状况和指标信息的应用程序中。 您还设置了一个配置值来告诉系统您的实现。 有关详细信息，请参阅https://helidon.io/docs/latest/index.html#/openapi/01_openapi 。

不幸的是，目前还没有任何自动方法可以将有关运行状况和指标的 OpenAPI 信息添加到应用程序的 OpenAPI 文档中。

更多信息（我似乎误解了原始问题）：

/metrics和/health端点由 Helidon实现，但 MicroProfile Metrics 和 Health 规范规定了这些端点的路径和行为。

一些帮助您入门的相关文件：

指标：

• 架构： https://github.com/eclipse/microprofile-metrics/blob/2.3.2/spec/src/main/asciidoc/architecture.adoc
• REST 端点： https://github.com/eclipse/microprofile-metrics/blob/2.3.2/spec/src/main/asciidoc/rest-endpoints.adoc

健康：

• 有线协议： https://github.com/eclipse/microprofile-health/blob/2.2/spec/src/main/asciidoc/protocol-wireformat.adoc