Jersey客户机/JAX-RS和可选（非默认）@queryparam（客户端）

Question

我有一个RESTful API，它的文档说某个查询参数是可选的，并且不提供默认参数。因此，我可以提供该值，也可以不将其作为参数发送到GET请求中。

示例：

• querya
是必需的
• queryb是可选的（可以在没有它的情况下发送get)

http://www.example.com/service/endpoint?queryA=foo&queryB=bar

http://www.example.com/service/endpoint?queryA=foo

我如何为Jersey-Proxy创建一个可以做到这一点的客户端接口？？我没有与服务器端代码进行接口，所以我通过jersey-proxy使用org.glassfish.jersey.client.proxy.WebResourceFactory生成与服务器API交互的客户端。

示例界面：

import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/service")
@Produces("application/json")
public interface ServiceInterface {

    @Path("/endpoint")
    @GET
    public Response getEndpoint(
            @QueryParam("queryA") String first,
            @QueryParam("queryB") String second);

}

我知道我可以做另一个方法：

    @Path("/endpoint")
    @GET
    public Response getEndpoint(
            @QueryParam("queryA") String first);

Answer 1

我不敢相信竟然这么容易：

import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/service")
@Produces("application/json")
public interface ServiceInterface {

    @Path("/endpoint")
    @GET
    public Response getEndpoint(
            @QueryParam("queryA") String first,
            @QueryParam("queryB") String second);

}

注意到问题界面有什么不同吗？？没有。那是因为那就是答案！

如果希望将参数默认为特定值，可以在参数中使用@defaultvalue注释：

import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/service")
@Produces("application/json")
public interface ServiceInterface {

    @Path("/endpoint")
    @GET
    public Response getEndpoint(
            @QueryParam("queryA") String first,
            @QueryParam("queryB") @DefaultValue("default") String second);

}

import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/service")
@Produces("application/json")
public interface ServiceInterface {

    @Path("/endpoint")
    @GET
    public Response getEndpoint(
            @QueryParam("queryA") String first,
            // Pass null to this parameter to not put it in the GET request
            @QueryParam("queryB") String second);

}

http://targethost.com/service/endpoint?queryA=firstQueryParam&queryB=secondQueryParam

并调用ServiceInterface.GetEndpoint（“FirstQueryParam”,null）；调用：

http://targethost.com/service/endpoint?queryA=firstQueryParam

还有瓦拉！没有第二个查询参数！：）

如果API接受原语值（如int、float、boolean等），则对该原语使用对象包装类（自动装箱）（如integer、float、boolean等）。然后，可以将null传递给该方法：

public Response getEndpoint(@QueryParam("queryA") Boolean first);