说出custom @QueryParam注释

Question

我正在使用expertion为我的Resteasy服务生成文档。我能够生成所需的文档，但我对一些自定义参数有疑问。

我们的服务接口由一个自定义的＜code＞@QueryParam＜/code＞注释组成，用于列出方法实现支持的所有查询参数。我现在不想解释为什么我们决定使用自定义的＜code＞@QueryParam＜/code＞，这只是一个架构决定。

尽管现在Enunciate无法识别自定义的＜code＞@QueryParam＜/code＞，所以我所有的Resteasy方法都没有＜code＞@QueryParam＞/code＜参数（只有＜code＞@@PathParam＜/code＞）。

示例服务接口：

@GET
@Path("{regionId}/{userId}/validate-access")
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@QueryParams(uniqueName = "validatePin", params = {
        @QueryParam(param = Param.PIN, isRequired = true),
        @QueryParam(param = Param.PIN_TYPE, isRequired = false, valueSet = { "valueA", "valueB" }, defaultValue = "valueA") })
StatusResponseResult validatePin(@Context HttpServletRequest hsr, @PathParam("regionId") int regionId,
        @PathParam("userId") int userId, @Context UriInfo info) throws RestApiException;

@QueryParam类的实现：

@Retention(RetentionPolicy.RUNTIME) 
public @interface QueryParam {
    public Param param();
    public boolean isRequired() default false;
    public boolean canBeEmpty() default true;
    public String defaultValue() default "";
    public String minValue() default "";
    public String maxValue() default "";
    public String format() default "";
    public String[] valueSet() default {};
}

@QueryParams类的实现:

@Retention(RetentionPolicy.RUNTIME)
public @interface QueryParams {
    String uniqueName();
    QueryParam[] params();
}

在生成HTML文档时，有没有一种方法可以让expertion也考虑我的自定义< code>@QueryParam？

Answer 1

好的，有了@ResourceMethodSignature我就可以获取文档中的所有参数（查询和路径）。唯一的缺点是我需要在@ResourceMethodSignature中再次列出参数。如果在添加新参数（或删除）时忘记更新@ResourceMethodSignature，则文档将不同步。

例子：

@ResourceMethodSignature(
      pathParams = { @PathParam("regionId"),@PathParam("userId") },
      queryParams = { @javax.ws.rs.QueryParam("pin"), 
                      @javax.ws.rs.QueryParam("pin_type") }
)

当您“阅读”所有@javax.ws.rs.QueryParam时，您认为您还可以考虑其他注释吗？

Answer 2

您可以尝试使用 @ResourceMethodSignature 注释来显式告诉 Enquiciate 该方法正在尝试执行的操作。更多信息在这里。

您可以尝试应用@QueryParams注释和@QueryParam注释。

如果这些都不起作用，我唯一能想到的就是创建一个自定义 Enarticulate 模块来设置自定义@QueryParams注释尝试声明的模型。更多（但不多）信息在这里。