arrays - 使用 OpenAPI v3 规范定义一个或多个字符串数组的正确方法

标签 arrays swagger openapi

这个问题在这里已经有了答案:





How can I define a property type as being a list (list, set, array, collection) of string in my YAML Swagger definition

(2 个回答)


3年前关闭。




我希望发布一个包含可变数量字符串的数组,例如

["string1", "string2", ... "stringN"]



我目前的 OpenAPI 文档是这样定义的:
schema:
  type: array
    items:
      description: networkIds
      type: string

这是对 OpenAPi v3 规范进行编码的正确方法,还是有更精确的方法来指示数组中的一个或多个字符串?

最佳答案

缩进不对- typeitems必须在同一级别。

如果数组不能为空并且总是至少有 1 项,则可以添加 minItems: 1作为额外的约束。如果所有项目都必须是唯一的,请添加 uniqueItems: true .

schema:
  type: array
  items:
    description: networkIds
    type: string
  minItems: 1

关于arrays - 使用 OpenAPI v3 规范定义一个或多个字符串数组的正确方法,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/47911331/

相关文章:

arrays - Perl Dancer - JSON 序列化器和 JSON 数组

java - API 文档 Swagger 中遗漏添加了 ExclusiveMaximum 注释

python - dask 数组分块如何适用于三个或更多维度?

arrays - GIN 或 GIST 可以用于 "containing at least"比较吗?

node.js - 向nestjs swagger添加服务器出现权限错误

c# - 带有 dotnet 核心的 Swagger 文档的文件返回类型

java.lang.IllegalStateException : Unable to read meta-data for class while implementing open api with spring boot

swagger - 如何在 Swagger 规范中接收动态响应

swagger - 使用 Swagger 描述多范围参数

PHP - 按列数组到 CSV