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

以昂首阔步的方式枚举字段名

邵阳德
2023-03-14

因此,我在网上进行了一些搜索,并能够找出如何在一个大摇大摆的文档中使用enum标记来指定一个字段的可能值列表。然而,在我当前的API中,我需要的是一个潜在字段列表,每个字段都有一个字符串值。

更准确地说,我有一个在请求正文中发送JSON的POST请求。作为该请求的一部分,用户需要发送单个ID字段。但是,我们接受多种类型的ID字段。因此请求如下所示:

{name:“name”,product:“product”,[FirstIdType,SecondIdType,ThirdIdType]:“id value”}

这是我的大摇大摆的医生的相关信息。需要更改的区域是ID字段。任何关于如何推进的想法或方向都将不胜感激。

definitions:
  request_post:
  description: (post) request schema
  properties:
    name:
      type: string
    product:
      type: string
    Id:
      type: string

共有1个答案

杨晓博
2023-03-14

您不必定义路径中可以包含哪些可选字段,而是可以标记所需的字段,并在默认情况下设置rest变量。

http://swagger.io/specification/#ParameterObject

required boolean确定此参数是否为强制参数。如果参数位于“path”中,则需要此属性,且其值必须为true。否则,可能包含该属性,其默认值为false。

 类似资料:
  • 数据类型。有关支持的数据类型,请参见文档。如果数据类型是自定义对象,请设置它的名称,或者不设置任何名称。对于枚举,使用'string'和allowableValues作为枚举常量。 但是我没有找到一些好的Java示例如何真正使用它,规范在这里。 你可以在这里看到结果。 我认为是个问题... 你知道吗?

  • 问题内容: 我想知道如何用昂扬的方式记录枚举。 根据JavaDoc 数据类型。请参阅文档以获取受支持的数据类型。如果数据类型是自定义对象,请设置其名称,或不设置任何名称。如果是枚举,请为枚举常量使用’string’和allowableValues。 但是我没有找到一些好的Java示例如何真正使用它,规范在这里。 第一服务 第二服务 输入项 天 输出量 pom.xml 您可以在此处查看结果。 我看到

  • 我们正在为我们的Laravel REST API实现开发Swagger文档。几个POSTendpoint将使用CSV作为参数内容类型。 Swagger中是否有一种方法可以让“立即尝试”功能与CSV POST文件上传一起使用? 下面是我们的留档http://api.curvecompass.com/docs/#/ 我们的Laravel POST函数可以正确地与CSVendpoint一起工作,而不是与

  • 问题内容: 我正在尝试使用swagger定义post端点,但是不允许使用该参数: 当我跑步时,我得到这个: 我的规格有什么问题? 问题答案: 您可能正在混合使用OpenAPI / Swagger 2.0和OpenAPI 3.0语法。您的规格似乎是2.0,但是关键字是3.0功能。在2.0中,请求正文被定义为正文参数: 更多信息:描述请求正文

  • 这不是springfox的故事,这是springdoc-openapi的故事。 我当前的依赖项 我的物业 此处请求(localhost:8080/swagger-ui.html)我的服务器响应swagger-petstore示例我已经知道petstore-disable(springdoc.swagger-ui.disable-swagger-default-url=true),但它不起作用 另一

  • 我如何指出在my_object中可以有property_1或property_2,但不能两者都有?