1

在我的项目中，我有一些子资源，根据 Jersey 框架指南正确实施。

但是，我在生成 openapi.json 文件（由 swagger-maven-plugin 生成）时遇到问题。特别是，我希望能够在@Api实现子资源的类上使用 swagger 注释来应用一些属性，例如授权。

问题是，如果我在子资源类上使用@Api 注解，swagger 不仅将这些类视为子资源，而且将其视为资源。结果是在 openapi.json 文件中，对于每个子资源，都会生成相同的资源（不应该存在）。

根资源：

@Path("root")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Api(value = "/root", authorizations = {
        @Authorization(value = "auth", scopes = {})
})
public class ExperienceResource {

    @Path("/sub_a")
    public SubResourceA getSubA() {
        return new SubResourceA();
    }

    @Path("/sub_b")
    public SubResourceB getSubB() {
        return new SubResourceB();
    }
}

子资源：

@Api(authorizations = {
     @Authorization(value = "auth", scopes = {})
})
public class SubResourceA {

    @GET
    ...
}

我也尝试过使用@Api(value="")or @Api(value="sub_a")，但它们不起作用或使事情变得更糟。显然，如果我删除 @Api 注释一切正常，但我被迫逐个应用属性操作。

有什么建议么？

4

1 回答 1

0

解决方案非常简单。为了确保实现子资源的类被 swagger 视为子资源（而不是资源），只需hidden = true在@Api注释中添加属性

   @Api(hidden = true, authorizations = {
     @Authorization(value = "auth", scopes = {})
})
public class SubResourceA {

    @GET
    ...
}
于 2020-05-28T20:14:40.867 回答