OpenAPI的Path Item对象总结及说明

Question

我正在使用 Jakarta REST（以前称为 JAX-RS）的

quarkus-rest

实现来开发 REST API。我还使用

quarkus-smallrye-openapi

扩展来生成我的 API 规范 (OpenAPI v3)。

如何使用注释或其他方式填写字段：路径项对象的摘要和描述？

Answer 1

您可以使用注释执行类似的操作：

@GET
@Path("options/{foo}")
public Response getFoo(
   @Schema(description = "some desc.",required = true)
   @PathParam("foo") String foo
) {
....

或者您可以通过将 openapi.yaml 放入 resources/META-INF 来合并/扩展/丰富生成的 openapi 规范。