当前位置: 首页 > 知识库问答 >
问题:

如何在OpenAPI/Swagger中指定一个字段是可选的还是必需的?

司马自明
2023-03-14

如何在OpenAPI/Swagger中定义一个字段是可选的或必需的,缺省的是什么?

共有1个答案

平羽
2023-03-14

另一种语法:

    Response:
      type: object
      required: [id, title]
      properties:
        id:
          type: string
        title:
          type: string
 类似资料:
  • 我有一个JSON模式文件,其中一个属性被定义为或: 当转换为YAML(用于OpenAPI/Swagger)时,它变为: 在OpenAPI中定义可为null属性的正确方法是什么?

  • 问题内容: 对于长数据类型,我可以在L后面加上数字以使编译器知道它长。字节和短怎么样? 作为动机,以下产生类型不匹配错误: 问题答案: 您实际上在谈论的是整数 文字 ()与长 文字 ()。实际上,在Java中没有短或字节字面量。但它 通常 并不重要,因为从整数常量的类型的隐式转换,和。从而: 仅当文字在所需范围内时,才允许隐式转换。如果不是,则需要类型转换。例如 在其他情况下,需要显式转换;例如,

  • 例如,endpoint 因此,如果有人将以下json发送到我的endpoint,endpoint应该接受它 但如果发送以下json,则失败,因为它不包含。

  • 我要求在有效负载中有两个属性,比如属性1和属性2。两者都是数组类型。条件是,要么两者都可以有值,要么其中只有一个为非空。但两者不能同时为空。我如何在swagger规范中定义这个需求,这样我就可以实施模式,使得两者都不应该为空,但是其中任何一个都可以为空。 有效示例: 无效示例:

  • 我想为我的Swagger API创建一个递归规范。这个概念似乎没有出现在Swagger文档中,所以我怀疑这是不可能的。因此,我也愿意接受任何由Swagger支持的替代解决方案。 例如,我试图创建一个类似文档的结构。每个文档都有部分,每个部分都有文本和自己的部分。我计划使用这样的APIendpoint: http://a.b.com/docs/{文档ID} http://a.b.com/docs/{

  • 我目前正在Spring Boot应用程序中使用OpenAPI 3(Swigger UI),我想知道如果我对所有API都使用相同的Java模型类,如何只为某些API指定某个字段是必需的/可选的。 这是我的样本: 这个类被用作几个API的输入请求,但只有其中一些API会要求这些字段都是必需的(即“密码”字段仅对登录API是必需的,而对注销API不是必需的)。 有没有一种方法可以使用OpenAPI的注释