在 helidon 項目中自動添加 openapi 文件

Question

我想要在我的 helidon 項目（Java 1.8，helidon SE 1.3.1）中自動生成 openapi 的工具

我閱讀文檔/示例並制作：

1. 添加依賴於 maven
2. 在 META-INF 中添加 openapi.yml
3. 為路由器添加端點。
4. 添加 apifilter 和 apimodelreader

pom.xml：

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

main.java：

return Routing.builder()
                .register(JsonSupport.create())
                .register(health)                   // Health at "/health"
                .register(metrics)                  // Metrics at "/metrics"
                .register("/file", fileService)
                .register("/card", cardService)
                .register(OpenAPISupport.create(config))
                .build();

應用程序.yaml

openapi:
  filter: ru.ittest.feezio.openapi.SimpleAPIFilter
  model:
    reader: ru.ittest.feezio.openapi.SimpleAPIModelReader

現在我在端點中有openapi文檔： http://127.0.0.1:8456/openapi這是我的openapi.yml。 但我不想手動編寫 openapi.yml，我想為我的類自動生成 yml：fileService 和 cardService。 此類工作和響應成功（API 工作，我現在制作文檔）

Answer 1

正如 OP 所指出的，Helidon SE 無法為您的應用自動生成 OpenAPI 文檔。 您提供static openapi.yml文件或您自己的 model 閱讀器和/或過濾器類。 如果需要，您可以提供 static 文件和類，但這不是必需的。 對於其他感興趣的讀者，這里是doc 。

可能大多數希望在其 Helidon SE 應用程序中支持 OpenAPI 的開發人員將使用一個工具來定義他們的 API，然后從該工具導出 OpenAPI 文檔，並將 YAML 文件添加到他們的應用程序META-INF/openapi.yml中。

請注意，如果您使用 Helidon MP（實現 MicroProfile OpenAPI）並將普通的 JAX-RS 注釋添加到您的端點，那么 Helidon MP 可以自動為您生成 OpenAPI 文檔。 這是文檔。