helidon项目中的自动添加openapi文件
helidon项目中的自动添加openapi文件
提问于 2019-10-08 01:47:30
我想要在我的helidon项目中自动生成openapi的仪器(Java1.8，helidon 1.3.1)
我读过文献/例子，并说：
- 在maven中添加依赖项
- 在META中添加openapi.yml
- 为路由器添加端点。
- 添加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();application.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工作，我现在做文档)
回答 1
Stack Overflow用户
回答已采纳
发布于 2019-10-16 13:04:41
正如OP所指出的，Helidon不能自动为您的应用程序生成OpenAPI文档。您可以提供静态openapi.yml文件或您自己的模型读取器和/或过滤器类。如果愿意，可以提供静态文件和类，但这不是必需的。对于其他感兴趣的读者，这里是文档。
可能大多数希望在Helidon应用程序中支持OpenAPI的开发人员将使用一个工具来定义他们的API，然后从该工具导出OpenAPI文档，并将该YAML文件添加到他们的应用程序JAR中(通常在META-INF/openapi.yml)。
请注意，如果您使用Helidon (它实现了MicroProfile OpenAPI)并将普通的JAX注释添加到您的端点，则Helidon可以自动为您生成OpenAPI文档。这是医生给你的。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/58283945
复制相关文章
相似问题
如何使用GitHub操作将git推送到管道中的GitHub
修改github操作管道中nupkg的版本
Github操作从管道创建秘密
与GitHub操作等效的GitLab管道
如何在Azure管道中使用GitHub操作？
添加站长 进交流群
领取专属 10元无门槛券
AI混元助手 在线答疑
关注 腾讯云开发者公众号
洞察 腾讯核心技术
剖析业界实践案例
腾讯云开发者
