Java REST API 查询注解

Question

我目前正在尝试向我的 REST 添加新功能 API。

基本上我想添加将查询参数添加到路径末尾的功能，并将其转换为所有查询选项的映射。

我当前的代码允许我做类似

的事情

localhost:8181/cxf/check/
localhost:8181/cxf/check/format
localhost:8181/cxf/check/a/b
localhost:8181/cxf/check/format/a/b

这将使用所有@pathparam 作为字符串变量来生成响应。

我现在要做的是添加：

localhost:8181/cxf/check/a/b/?x=abc&y=def&z=ghi&...
localhost:8181/cxf/check/format/a/b/?x=abc&y=def&z=ghi&...

然后我会生成一个映射，它可以与路径参数一起用于构建响应

x => abc
y => def
z => ghi
... => ...

我在想这样的事情 [下面] 但是 @QueryParam 似乎只处理一个键值而不是它们的映射。

@GET
@Path("/{format}/{part1}/{part2}/{query}")
Response getCheck(@PathParam("format") String format, @PathParam("part1") String part1, @PathParam("part2") String part2, @QueryParam("query") Map<K,V> query);

下面是我当前的界面代码。

@Produces(MediaType.APPLICATION_JSON)
public interface RestService {

@GET
@Path("/")
Response getCheck();

@GET
@Path("/{format}")
Response getCheck(@PathParam("format") String format);

@GET
@Path("/{part1}/{part2}")
Response getCheck(@PathParam("part1") String part1,@PathParam("part2") String part2);

@GET
@Path("/{format}/{part1}/{part2}")
Response getCheck(@PathParam("format") String format, @PathParam("part1") String part1, @PathParam("part2") String part2);

}

Answer 1

QueryParam("") myBean 允许获取所有注入的查询参数。也删除最后 {query} 部分

@GET
@Path("/{format}/{part1}/{part2}/")
Response getCheck(@PathParam("format") String format, @PathParam("part1") String part1, @PathParam("part2") String part2, @QueryParam("") MyBean myBean);

 public class MyBean{
    public void setX(String x) {...}
    public void setY(String y) {...}  
 }

也可以不声明参数，不解析URI。如果您可以接受非固定参数，此选项可能会有用

 @GET
 @Path("/{format}/{part1}/{part2}/")
 public Response getCheck(@PathParam("format") String format, @PathParam("part1") String part1, @PathParam("part2") String part2, @Context UriInfo uriInfo) {
    MultivaluedMap<String, String> params = uriInfo.getQueryParameters();
    String x= params.getFirst("x");
    String y= params.getFirst("y");
}

Java REST API 查询注解

Java REST API Query annotation

java

rest

web-services

cxf

javax.ws.rs