在 openapi 文件中添加 helidon objects health and metrics

Question

我正在为我的 helidon 项目中的服务编写文件 openapi.yml，其中包含 openapi 3.0 描述。但我也使用标准的 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

您可以通过两种方式执行此操作：

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

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

补充资料（我好像误解了原问题）：

/metrics 和 /health 端点由 Helidon 实现，但 MicroProfile 指标和健康规范规定了这些端点的路径和行为.

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

指标：

健康：

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

在 openapi 文件中添加 helidon objects health and metrics

Add in openapi file helidon objects health and metrics

java

openapi

helidon