如何创建带有输入参数的 Restful Web 服务？

Question

我正在创建宁静的 Web 服务，我想知道如何使用输入参数创建服务以及如何从 Web 浏览器调用它。

例如

@Path("/todo")
public class TodoResource {
    // This method is called if XMLis request
    @PUT
    @Produces( {MediaType.APPLICATION_XML,MediaType.APPLICATION_JSON})
    public Todo getXML() {
        Todo todo = new Todo();
        todo.setSummary("This is my first todo");
        todo.setDescription("This is my first todo");
        return todo;
    }

，我可以使用调用它 http://localhost:8088/JerseyJAXB/rest/todo

我想创建一个像

@Path("/todo")
    public class TodoResource {
        // This method is called if XMLis request
        @PUT
        @Produces( {MediaType.APPLICATION_XML,MediaType.APPLICATION_JSON})
        public Todo getXML(String x, String y) {
            Todo todo = new Todo();
            todo.setSummary(x);
            todo.setDescription(y);
            return todo;
        }

基于肥皂的 方法Web 服务我会像这样调用它

http://localhost:8088/JerseyJAXB/rest/todo?x=abc&y=pqr

但我想知道如何使用休息来调用它，并且当我使用休息和球衣时，我是否可以像在上面的示例中所做的那样传递参数。

Answer 1

你可以。
尝试这样的操作：

@Path("/todo/{varX}/{varY}")
@Produces({"application/xml", "application/json"})
public Todo whatEverNameYouLike(@PathParam("varX") String varX,
    @PathParam("varY") String varY) {
        Todo todo = new Todo();
        todo.setSummary(varX);
        todo.setDescription(varY);
        return todo;
}

然后使用此 URL 调用您的服务；
http://localhost:8088/JerseyJAXB/rest/todo/summary/description

Answer 2

如果您需要查询参数，请使用@QueryParam。

public Todo getXML(@QueryParam("summary") String x, 
                   @QueryParam("description") String y)

但您将无法从普通 Web 浏览器发送 PUT（目前）。如果直接输入 URL，它将是 GET。

不过，从哲学​​上来说，这看起来应该是一个 POST。在 REST 中，您通常可以 POST 到公共资源 /todo（该资源在其中创建并返回新资源），或者 PUT 到专门标识的资源，例如 /todo/< ;id>，用于创建和/或更新。

Answer 3

当心。为此，您需要@GET（而不是@PUT）。

Answer 4

另一种方法是获取 UriInfo 而不是所有 QueryParam

然后您将能够根据代码中的需要获取 queryParam

@GET
@Path("/query")
public Response getUsers(@Context UriInfo info) {

    String param_1 = info.getQueryParameters().getFirst("param_1");
    String param_2 = info.getQueryParameters().getFirst("param_2");


    return Response ;

}

Answer 5

您可以尝试这个...将参数设置为：
http://localhost:8080/WebApplication11/webresources/generic/getText?arg1=你好
在你的浏览器中...

package newpackage;

import javax.ws.rs.core.Context;
import javax.ws.rs.core.UriInfo;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.Consumes;
import javax.ws.rs.DefaultValue;


import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PUT;
import javax.ws.rs.QueryParam;

@Path("generic")
public class GenericResource {

    @Context
    private UriInfo context;

    /**
     * Creates a new instance of GenericResource
     */
    public GenericResource() {
    }

    /**
     * Retrieves representation of an instance of newpackage.GenericResource

     * @return an instance of java.lang.String
     */
    @GET
    @Produces("text/plain")
    @Consumes("text/plain")
    @Path("getText/")
    public String getText(@QueryParam("arg1")
            @DefaultValue("") String arg1) {

       return  arg1 ;  }

    @PUT
    @Consumes("text/plain")
    public void putText(String content) {





    }
}