如何使用 curl 测试 Java RESTful 网络服务 - PUT 动词的问题

Question

我正在尝试我的第一个 Java RESTful 网络服务，可能我没有明确的一些机制。

这是我的代码示例：

@Path(Paths.USERS)
public class UserService {

    private static final String OK_MESSAGE_USERSERVICE_PUT = Messages.OK_MESSAGE_USERSERVICE_PUT;
    private Client esClient = ElasticSearch.getClient();

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public String get(@QueryParam(QParams.ID) String id) {
        // TODO Authentication
        try {
            GetResponse response = esClient
                    .prepareGet(PRIMARY_INDEX_NAME, USERS_TYPE_NAME, id)
                    .execute().actionGet();

            if (response != null) {
                return response.getSourceAsString();
            }


        }catch (ElasticsearchException e) {
            e.printStackTrace();
            return e.getMessage();
        }
        return Messages.RESOURCE_NOT_FOUND;
    }

    @PUT
    @Consumes(MediaType.APPLICATION_JSON)
    public String update(@QueryParam(QParams.ID) String id,
            @PathParam("metadata") String metadata) {
        // TODO Authentication
        boolean isMyself = true;

        // precondition, the user exsists. If the check fails, you
        // should put the isMyself flag at false.
        if (isMyself){

                    esClient
                    .prepareIndex(PRIMARY_INDEX_NAME, USERS_TYPE_NAME, id)
                    .setSource(metadata).execute().actionGet();
        }

        return OK_MESSAGE_USERSERVICE_PUT;
    }

我的问题是：

我应该如何将元数据传递给网络服务？ 我试过

 curl -g -X PUT 'http://localhost:8080/geocon/users?id=007&metadata={"name":{"first":"james","last":"bond"}}'

但我遇到了

这样的错误

Root Cause: java.net.URISyntaxException: Illegal character in query at index 33: /geocon/users?id=007&metadata=%7B"name":%7B"first":"james","last":"bond"%7D%7D
    java.net.URI$Parser.fail(URI.java:2848)

谷歌搜索，我尝试了这个不同的解决方案：

curl -X PUT -H "application/json" -d '{"name":{"first":"james","last":"bond"}}' http://localhost:8080/geocon/users/

但是使用这种方法，我不知道如何将我更新 ID 为 007 的用户的意愿传递给网络服务（因为，据我所知，我只是在交流 {"name":{"first":"james","last":"bond"}}).

你会怎么做？谢谢！

Answer 1

看起来您将参数传递给 GET 请求 (?foo=bar) 的方式与 PUT 方法混合在一起，这更像是 POST。

我希望您将 JSON 数据发送到 URL，例如 /gecon/user/13，当然是在正确编辑 URL 映射之后。

尝试阅读 the wikipedia and this answer。

Answer 2

我会完全重构这个解决方案。

首先：更改url方案，使id成为URI路径的一部分。这是一种更 RESTful 的方法

@PUT
@Path("{id}")
@Consumes(MediaType.APPLICATION_JSON)
public String update(@PathParam("id") String id) {

其二：请求实体主体应该是JSON。我不认为这是 "metadata" 的任何理由。你可以完全摆脱它。你想用你发送的数据更新资源表示，所以这应该是正文的一部分。

第三： 如果您正在使用 JSON，您应该利用像 Jackson 这样的提供商提供的 Pojo 映射。这会自动将 JSON 解析为 Pojo。你可以做类似

的事情

public class Agent {
    private Name name;
    // getters and setters

    public static class Name {
        private String first;
        private String last;
        // getters and setters
    }  
}

然后在方法签名中只包含 Agent 参数，表示它是请求的主体。

@PUT
@Path("{id}")
@Consumes(MediaType.APPLICATION_JSON)
public String update(@PathParam("id") String id, Agent agent) {

您需要将 Jackson 提供程序添加到项目中。希望您正在使用 Maven。您可以添加

<dependency>
    <groupId>com.fasterxml.jackson.jaxrs</groupId>
    <artifactId>jackson-jaxrs-json-provider</artifactId>
    <version>2.4.0</version>
</dependency>

然后在您的应用程序配置中，注册 JacksonJsonProvider。如果您需要这方面的帮助，请展示您是如何配置您的应用程序的（无论是 web.xml 还是 Application 子类）。如果您想跳过 Pojo 映射并只获取原始 JSON，只需将方法参数类型设置为 String，就像您已经在做的那样（只是没有注释）

第四：那么你的要求是（我在Windows，这里我们需要使用双引号并转义内部引号）

curl -v -X PUT
        -H "Content-Type:application/json"
        -d "{\"name\":{\"first\":\"james\", \"last\":\"bond\"}}"
        http://localhost:8080/geocon/users/007

第五： 我也会更改 @GET 方法，使 id 成为 URL 路径的一部分，而不是查询参数。

如何使用 curl 测试 Java RESTful 网络服务 - PUT 动词的问题

How to test a Java RESTful web service with curl - problems with PUT verb

java

rest

curl

jax-rs

jersey