使用 quarkus-smallrye-openapi 定义通用 API 信息的文档扩展极其稀疏，并且没有解释如何使用所有注释来设置 openApi 生成。
对于某些背景，我使用的是从 1.0.1.FINAL 生成的干净且大部分为空的项目(quarkus 版本 code.quarkus.io)。 , 单个类定义如下(尝试使用 @OpenAPIDefinition 注释):
@OpenAPIDefinition(
info = @Info(
title = "Custom API title",
version = "3.14"
)
)
@Path("/hello")
public class ExampleResource {
@GET
@Produces(MediaType.TEXT_PLAIN)
public String hello() {
return "hello";
}
}
我最终通过大量挖掘发现一般的 api 信息(联系信息、版本等)是使用
@OpenAPIDefinition 定义的。注释，但在我现有的端点定义上使用时，不会对生成的 openapi 规范进行任何更改。我究竟做错了什么？
最佳答案
尝试将注释放在 JAX-RS 应用程序类上。我意识到您不需要 Quarkus 应用程序中的其中一个，但我认为它也不会受到伤害。供引用 TCK 规范:
https://github.com/eclipse/microprofile-open-api/blob/master/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/JAXRSApp.java
关于annotations - @OpenAPIDefinition 放在哪里？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/59168710/