如何为TypeScript接口{[key: string]: string[]}编写OpenAPI 3.x.x Schema？

你提供的TypeScript接口Test是一个字符串索引签名，表示对象的任意字符串键对应的值都是字符串数组。对应的OpenAPI 3.x Schema可以这样写：

Test:
  type: object
  additionalProperties:
    type: array
    items:
      type: string

关键说明： #

• type: object：声明这是一个对象类型
• additionalProperties：用来定义对象中所有未显式声明的键值对的结构，正好对应TS里的索引签名
• 嵌套的type: array + items: { type: string }：指定值必须是由字符串组成的数组

如果需要用JSON格式的Schema，写法如下：

{
  "Test": {
    "type": "object",
    "additionalProperties": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

内容的提问来源于stack exchange，提问作者mat.twg