带有路径变量和请求参数的Swagger codegen maven插件OpenApi生成不工作的代码

Question

我正面临着一个昂首阔步的协成器生成存根的问题。我有2个服务。首先公开REST api与路径var和请求参数的两个方法：

    @GetMapping(value = "/start/{pathVar}/operators", params = "login")
    public Operator getOperatorByLogin(
                @ApiParam @PathVariable Long pathVar, 
                @ApiParam(required = true) @RequestParam  String login) {
        return operatorRepository.findDistinctByLogin(login);
    }

和

    @GetMapping(value = "/start/{pathVar}/operators", params = "ids")
    public List<Operator> getOperatorsByIds(
                @ApiParam @PathVariable Long pathVar, 
                @ApiParam( allowMultiple = true) @RequestParam List<Long> ids) {
        return operatorRepository.findAllByOperatorIdIn(ids);
    }

有两个endpoint具有相同的URL，但参数不同。springwebframework就是这样工作的。接下来，我生成OpenApi json并获得2条路径：

"/start/{pathVar}/operators{?ids}": ...
"/start/{pathVar}/operators{?login}": ...

然后，我试图用swagger codegen maven为该endpoint生成插件存根，然后我就面临了这个问题。

异常在线程"main"java.lang.IllegalArgumentExc0019：地图没有值'？登录

这种形式的URL是在生成的类中硬编码的。

(...)
final Map<String, Object> uriVariables = new HashMap<String, Object>();
uriVariables.put("pathVar", pathVar);
String path = UriComponentsBuilder.fromPath(
"/start/{pathVar}/opeartors{?login}").buildAndExpand(uriVariables).toUriString();
(...)

引发异常，因为uriVariables中缺少登录映射键值。

Answer 1

在定义文件（.json或.yml）上为参数定义正确的类型时，您应该小心，因为有两种参数：

1. 路径参数（GET/users/{id}）
2. 查询参数（GET/user/findByLogin？name=myUserLogin）

这两个在OpenAPI中有两个不同的声明

1） 路径参数

paths:
  /users/{id}:
    get:
      parameters:
        - in: path
          name: id   # Note the name is the same as in the path
          required: true
          schema:
            type: integer
            minimum: 1
          description: The user ID

2） 查询参数

parameters:
    - in: query
      name: myUserLogin
      schema:
        type: integer
        description: The number of items to skip before starting to collect the result set

有关更多详细信息，请查看官方文档