swagger标签说明

本文介绍了如何在YAML中使用x-ref-external引用已存在的数据类PageVO,并展示了如何在MyResponse对象中集成分页信息。重点在于数据结构的定义和引用方式,以及如何处理错误信息。
摘要由CSDN通过智能技术生成

x-ref-external可以为yaml里的数据结构指定一个已有的数据类,例如:

PageVO:
    x-ref-external: com.lee.PageVO
    properties:
      totalRows:
        type: string
        description: 总条数
      curPage:
        type: string
        description: 当前页
      pageSize:
        type: string
        description: 页大小

指定了x-ref-external的数据结构里的properties只是起到一个方便阅读的作用,并不会根据properties真的生成属性。
然后,注意在引用的时候要x-imports:

MyResponse:
    type: object
    properties:
      data:
        items:
          $ref: '#/definitions/DataInfo'
        description: 返回业务数据
        type: array
      code:
        type: string
        description: 错误码
      message:
        type: string
        description: 错误提示
      pageVO:
        description: 分页信息
        $ref: '#/definitions/PageVO'
    description: 查询响应类
    x-imports:
      - com.lee.PageVO 
  • 6
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值