java如何在OpenAPI3.0中为GetAPI定义映射对象

Question

我有一个API，它将Map作为请求参数。如何在OpenAPI3.0中以yaml格式定义它

@GetMapping
public void getDevicesInfo(@RequestParam(required = false) Map parameters)
{

}

Open API不支持映射类型

Answer 1

在YAML文件中，需要在Java中为Map添加additionalProperties，并使用parameters作为@RequestParam：

/api/v1/test:
  get:
    tags:
      - test
    operationId: getDevicesInfo
    parameters:
      - name: parameters
        in: query
        required: false
        schema:
          type: object
          additionalProperties:
            type: object
    responses:
      '200':
        description: OK

生成的GET API如下所示：

我希望它能帮助你：）