我在swaggerhub网站上,我需要做一个API文档。我试图定义一个具有多个元素的对象,其中大多数是基本的,但其中一个属性是另一个对象,不是ARRAY,但该子对象可以包含一个或多个属性(所有相同类型)。
我需要创建一个看起来像数组的对象。
假设我的大对象是'User',而给我带来问题的对象是'addresses':
User:
properties:
name:
type: string
adresses:
type: object
的例子:
User:
name: Alex
addresses: {
address: {...}
address2: {....}
address3: {....}
}
我已经定义了Address类型,但是'addresses'必须是一个对象(这意味着它应该看起来像json,而不是[])。我如何使"地址"有可变长度??可能有4个地址,也可能只有2个。
我想在API文档中为此编写示例,并且我希望它是可变长度的,因为这就是API实际工作的方式,使用JSON,而不是数组。
您是否检查了OpenAPI规范页面,以帮助编写API定义的部分?这是一个很好的资源,深入介绍了如何编写API的多个方面。
规格页面在这里:https://swagger.io/specification/
您可以浏览左侧的主题。这里应该有帮助的是规范>模式。有很多关于如何编写各种类型的对象的信息。