对于使用相同参数的多个REST API调用，最佳做法是什么

Question

我有一个接收各种参数的REST API列表，这些参数旨在搜索、过滤和返回数据到前端。

@GetMapping(value = "/api1", params = {"x,y,z,age,location"})
@GetMapping(value = "/api2", params = {"a,b,c,d,age,location"})
@GetMapping(value = "/api3", params = {"p,q,r,s,,age,location"})
@GetMapping(value = "/api4", params = {"p,q,r,s,,age,location"})
@GetMapping(value = "/api5", params = {"p,q,r,s,,age,location"})

正如您所注意到的，问题在于存在一些参数（年龄、位置），这些参数对于所有这些endpoint都是通用的。

我们的计划是，我们可能需要为所有这些endpoint引入一个新参数，如“性别”。是否有一种最佳实践可以跨API处理这些公共参数，这样我们就不需要修改每个控制器并添加新添加的请求参数？

控制器看起来像这样：

@RestController
public class UserFilterController {


    @GetMapping(path = "/api1")
    public ResponseEntity filterUserWithApi1(String x, String y, String z, String age, String location) {

        return new ResponseEntity(HttpStatus.OK);
    }

    @GetMapping(path = "/api2")
    public ResponseEntity filterUserWithApi2(String a, String b, String c, String age, String location) {

        return new ResponseEntity(HttpStatus.OK);
    }

    @GetMapping(path = "/api3")
    public ResponseEntity filterUserWithApi3(String d, String e, String f, String age, String location) {

        return new ResponseEntity(HttpStatus.OK);
    }

    @GetMapping(path = "/api4")
    public ResponseEntity filterUserWithApi4(String g, String s, String h, String age, String location) {

        return new ResponseEntity(HttpStatus.OK);
    }

    @GetMapping(path = "/api5")
    public ResponseEntity filterUserWithApi5(String j, String k, String l, String age, String location) {

        return new ResponseEntity(HttpStatus.OK);
    }

}

Answer 1

我相信您的查询参数是一个具有多个值的单一属性，并且年龄/位置是最后出现的一些其他强制查询参数。这就是我将如何编写已知给定参数的控制器

         @GetMapping(path = "/test")
        public Map<String, String> test(@RequestParam("alphabets") Set<String> alphabets,
                                        @RequestParam("age") int age,
                                        @RequestParam("location") String location) {
            final Map<String, String> responseMap = new HashMap<>();
            responseMap.put("alphabets", alphabets.toString());
            responseMap.put("age", Integer.toString(age));
            responseMap.put("location", location);
            return responseMap;
        }

此控制器的调用如下所示

http://localhost:8080/test?alphabets=a&age=1&location=test
http://localhost:8080/test?alphabets=a,b,c&age=1&location=test

现在，您可以基于字母表中的值创建连接。

非常感谢。

Answer 2

如果路径不相同，您不需要在注释中设置params字段，您可以简单地执行：

@GetMapping(path = "/api1")
public void myFunction( @RequestParam("age") String age, @RequestParam("location") String location, ... ) {
...
}

如果路径相同，也可以这样做，但需要在RequestParam注释中添加“required=false”，并手动处理当某些字段存在或不存在时的操作

Answer 3

如果您不知道请求中将有多少个参数，可以使用@RequestParam作为映射，如下所示-

@GetMapping(path = "/api1")
public void test(@RequestParam Map<String, String> parameters) {
    //TODO
    String value1 = parameters.get("key1");
    ........
}

你可以通过下面的参数-

/api1?key1=value1&key2=value2...

或-

@GetMapping(path = "/api1/{age}/{location}")
public ResponseEntity filterUserWithApi1(@PathVariable("age") String age,
                                         @PathVariable("location") String location,
                                         @RequestParam("x") String x,
                                         @RequestParam("y") String y,
                                         @RequestParam("z") String z) {
    return new ResponseEntity(HttpStatus.OK);
}

请求-

/api1/24/earth?x=x_value&y=y_value&z=z_value

或-

@GetMapping(path = "/api1/{age}/{location}/{x}/{y}/{z}")
public ResponseEntity filterUserWithApi1(@PathVariable("age") String age,
                                         @PathVariable("location") String location,
                                         @PathVariable("x") String x,
                                         @PathVariable("y") String y,
                                         @PathVariable("z") String z) 
{
    return new ResponseEntity(HttpStatus.OK);
}

请求-

/api1/<age_value>/<location_value>/<x_value>/<y_value>/<z_value>