Swagger 招摇过市-如何编写通用响应字段?
我有几个API,它们都返回JSON,并带有一个名为Swagger 招摇过市-如何编写通用响应字段?,swagger,swagger-2.0,Swagger,Swagger 2.0,我有几个API,它们都返回JSON,并带有一个名为success的布尔字段 API 1 {“success”:true,“data”:“some data”} API 2 {“success”:false,“error”:“error message”} 我可以用模板之类的东西来编写它的swagger 2.0文档吗,这样我就不需要像这样在每个API中复制和粘贴成功字段部分了 responses: 200: schema: properties:
success
的布尔字段
API 1
{“success”:true,“data”:“some data”}
API 2
{“success”:false,“error”:“error message”}
我可以用模板之类的东西来编写它的swagger 2.0文档吗,这样我就不需要像这样在每个API中复制和粘贴成功字段部分了
responses:
200:
schema:
properties:
success:
type: boolean
description: true if the request is successful.
data:
...
响应:
200:
模式:
特性:
成功:
类型:布尔型
描述:如果请求成功,则为true。
数据:
...
及
响应:
200:
模式:
特性:
成功:
类型:布尔型
描述:如果请求成功,则为true。
错误:
...
谢谢 是,对公共字段使用
allOf
:
responses:
200:
schema:
allOf:
- $ref: '#/definitions/common'
- properties:
data:
# your details here
definitions:
Common:
type: object
properties:
success:
type: boolean
description: true if the request is successful.
此外:
是,对公共字段使用
allOf
:
responses:
200:
schema:
allOf:
- $ref: '#/definitions/common'
- properties:
data:
# your details here
definitions:
Common:
type: object
properties:
success:
type: boolean
description: true if the request is successful.
此外:
schema:
allOf:
- $ref: '#/definitions/Common'
- properties:
data:
$ref: '#/definitions/Another'