swagger标签说明

发布时间:2024年01月16日

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 
文章来源:https://blog.csdn.net/tlxamulet/article/details/135627638
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。