将多个参数传递给RESTAPI-Spring

Question

我试图找出是否有可能传递一个JSON对象RestAPI，或传递多个参数到该API？如何在Spring中读取这些参数？让我们假设url看起来像下面的例子：

例1<代码>http://localhost:8080/api/v1/mno/objectKey?id=1

传递下面url中的JSON对象是否有效？

例2<代码>http://localhost:8080/api/v1/mno/objectKey/{“id”：1，“name”：“Saif”}

问题：

1） 是否可以像Ex.2那样将JSON对象传递给url？

2）我们如何传递和解析Ex1中的参数？

我试图写一些方法来实现我的目标，但找不到正确的解决方案？

我试图将JSON对象作为@RequestParam传递

http://localhost:8080/api/v1/mno/objectKey?id=1出现意外错误（type=Unsupport Media Type， state=415）。不支持内容类型null

http://localhost:8080/api/v1/mno/objectKey/id=1出现意外错误（类型=未找到，状态=404）。没有可用的消息

http://localhost:8080/api/v1/mno/objectKey/{"id"： 1}有一个意外的错误（type=未找到，state=404）。没有可用的消息

@RequestMapping(value="mno/{objectKey}",
                method = RequestMethod.GET, 
                consumes="application/json")
    public List<Book> getBook4(@RequestParam ObjectKey objectKey) {
        ...
    }

我试图将JSON对象作为@PathVariable传递

@RequestMapping(value="ghi/{objectKey}",method = RequestMethod.GET)
    public List<Book> getBook2(@PathVariable ObjectKey objectKey) {
        ...         
    }

我创建这个对象是为了保存id参数和其他参数，如name等。。。。

class ObjectKey{
        long id;
        public long getId() {
            return id;
        }
        public void setId(long id) {
            this.id = id;
        }
    }

Answer 1

可以如下所示给出多个参数，

    @RequestMapping(value = "/mno/{objectKey}", method = RequestMethod.GET, produces = "application/json")
    public List<String> getBook(HttpServletRequest httpServletRequest, @PathVariable(name = "objectKey") String objectKey
      , @RequestParam(value = "id", defaultValue = "false")String id,@RequestParam(value = "name", defaultValue = "false") String name) throws Exception {
               //logic
}

Answer 2

您可以在url中传递多个参数，如

http://localhost:2000/custom?brand=dell

为了得到这个查询字段，您可以使用map-like

    @RequestMapping(method = RequestMethod.GET, value = "/custom")
    public String controllerMethod(@RequestParam Map<String, String> customQuery) {

        System.out.println("customQuery = brand " + customQuery.containsKey("brand"));
        System.out.println("customQuery = limit " + customQuery.containsKey("limit"));
        System.out.println("customQuery = price " + customQuery.containsKey("price"));
        System.out.println("customQuery = other " + customQuery.containsKey("other"));
        System.out.println("customQuery = sort " + customQuery.containsKey("sort"));

        return customQuery.toString();
    }

Answer 3

（1） 是否可以像Ex.2那样将JSON对象传递给url？

不，因为http://localhost:8080/api/v1/mno/objectKey/{“id”：1，“name”：“Saif”}不是有效的URL。

如果您想使用RESTful方式，请使用http://localhost:8080/api/v1/mno/objectKey/1/Saif，并将您的方法定义为：

@RequestMapping(path = "/mno/objectKey/{id}/{name}", method = RequestMethod.GET)
public Book getBook(@PathVariable int id, @PathVariable String name) {
    // code here
}

（2） 我们如何传递和解析Ex.1中的参数？

只需添加两个请求参数，并给出正确的路径。

@RequestMapping(path = "/mno/objectKey", method = RequestMethod.GET)
public Book getBook(@RequestParam int id, @RequestParam String name) {
    // code here
}

更新（来自评论）

如果我们有一个复杂的参数结构呢？

"A": [ {
    "B": 37181,
    "timestamp": 1160100436,
    "categories": [ {
        "categoryID": 2653,
        "timestamp": 1158555774
    }, {
        "categoryID": 4453,
        "timestamp": 1158555774
    } ]
} ]

将其作为POST发送，JSON数据在请求正文中，而不是URL中，并指定application/JSON的内容类型。

@RequestMapping(path = "/mno/objectKey", method = RequestMethod.POST, consumes = "application/json")
public Book getBook(@RequestBody ObjectKey objectKey) {
    // code here
}