如何在 Open API 3.0 中為 GET API 定義地圖對象

Question

我有 GET API，它將 Map 作為請求參數。 如何在 Open API 3.0 中以 yaml 格式定義它

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

}

Open API 不支持 Map 類型。

Answer 1

在您的YAML文件中，您需要在 Java 中為Map添加additionalProperties並使用@RequestParam parameters為：

/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 如下所示：

我希望它可以幫助你:)