java - 如何在 Open API 3.0 中为 GET API 定义 map 对象

Question

我有 GET API，它将 Map 作为请求参数。如何在 Open API 3.0 中以 yaml 格式定义它

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

}

Open API 不支持 Map 类型。

Answer 1

在您的 YAML您需要添加的文件 additionalProperties为 Map在 Java 中使用 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 如下所示:



我希望它可以帮助你:)