如何在 OpenAPI 2.0 中定义对象数组?
How to define an array of objects in OpenAPI 2.0?
我是 swaggerhub 的新手。我需要定义一个 API,请求需要像这样 json:
{
"acountNumber": "1234564545444854",
"warningTypes":[
{
"warningCode": 122,
"warningMessage": "string message"
}
]
}
此刻我有这个:
definitions:
WarningCodes:
type: object
required:
- accountNumber
- warningCodes
- messages
properties:
accountNumber:
type: string
example: 1234567890
warningTypes:
type: array
items:
type: object
properties:
warningCode:
type: integer
warningMessage:
type: string
不是那样工作的。
似乎需要一个新的实体,像这样
definitions:
WarningCodes:
type: object
required:
- accountNumber
- warningCodes
- messages
properties:
accountNumber:
type: string
example: '1234567890'
warningTypes:
type: array
items:
$ref: '#/definitions/WarningType'
WarningType:
type: object
properties:
warningCode:
type: integer
example: 122
warningMessage:
type: string
minLength: 0
maxLength: 256
example: test1,test
我是 swaggerhub 的新手。我需要定义一个 API,请求需要像这样 json:
{
"acountNumber": "1234564545444854",
"warningTypes":[
{
"warningCode": 122,
"warningMessage": "string message"
}
]
}
此刻我有这个:
definitions:
WarningCodes:
type: object
required:
- accountNumber
- warningCodes
- messages
properties:
accountNumber:
type: string
example: 1234567890
warningTypes:
type: array
items:
type: object
properties:
warningCode:
type: integer
warningMessage:
type: string
不是那样工作的。
似乎需要一个新的实体,像这样
definitions:
WarningCodes:
type: object
required:
- accountNumber
- warningCodes
- messages
properties:
accountNumber:
type: string
example: '1234567890'
warningTypes:
type: array
items:
$ref: '#/definitions/WarningType'
WarningType:
type: object
properties:
warningCode:
type: integer
example: 122
warningMessage:
type: string
minLength: 0
maxLength: 256
example: test1,test