网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

swagger标签使用指南

更新时间:2024-11-13 GMT+08:00
分享

本章节为您介绍swagger的通用标签,帮助能更好的编辑swagger文件,完成业务设计。

1、x-query-param-body

作用:

图1 使用背景

此功能需要结合metadata.json使用,对应到metadata.json中的参数:generatorPolicy.queryParamLimit

通过x-query-param-body标签,可以自定义转换的对象的名称。

标签值类型

String

使用位置

paths.path.operation.x-query-param-body(定义在指定Get请求的api上时,只影响该api)

使用示例

paths:
  /v1/cards:
    get:
      tags:
      - "CARD"
      summary: "查询所有Card"
      description: "Returns all Card"
      operationId: "ListCards"
      x-is-registered: 'N'
      x-support-sdk: 'N'
      x-mybatis-paging: true
      x-query-param-body: CardQo  #此处设置了x-query-param-body
      parameters:
        ------

使用效果:

使用前:

ResponseEntity<Message<PageInfo<Card>>> listCards( @RequestObject ListCardsQo listCardsQo);

使用后:

ResponseEntity<Message<PageInfo<Card>>> listCards( @RequestObject CardQo cardQo);

2、x-default-empty

作用

只支持get请求,指定String类型参数生成默认值为""。

说明:

需要配合metadata元数据中generatorPolicy的queryParamLimit使用,当将请求参数转换为对象后此标签才会生效。

标签值类型

boolean

使用位置

paths.path.operation.parameters.name.x-default-empty

说明:

当该标签置为true时,原定义默认值的default标签失效,该标签只可用于定义String参数为""。

使用示例

paths:
  /v1/cards:
    get:
     # 该接口设置了查询参数转换为对象的功能,最终所有的参数都会自动定义到一个对象中
      tags:
      - "CARD"
      summary: "查询所有Card"
      description: "Returns all Card"
      operationId: "ListCards"
      x-is-registered: 'N'
      x-support-sdk: 'N'
      x-mybatis-paging: true
      x-query-param-body: CardQo
      parameters:
      - name: "creator"
        in: "query"
        description: "creator"
        required: false
        type: "string"
        x-default-empty: true   # 使用 x-default-empty 指定creator的默认值为 ""

-----

使用效果:

使用前:

public class ListCardsQo implements Serializable {
    private static final long serialVersionUID = 1L;
    @JsonProperty("creator")
    private String creator = null;   // 此处生成的creator默认值为 null

    ------
}

使用后:

public class CardQo implements Serializable {   // 该示例使用了x-query-param-body指定了对象名为CardQo,所以和使用前的的示例中类名不一样
    private static final long serialVersionUID = 1L;
    @JsonProperty("creator")
    private String creator = "";  //此处生成的creator的默认值为 ""

    -------
}

3、x-imports

作用

自主定义类中需要添加的 import 引用。

标签值类型

List

使用位置

  • x-imports(当定义在swagger的最外层时,所有的类中都会引入import)
  • components.schemas.model.properties.property.x-imports(当定义在dto的字段中时,只会在该dto类中引入import)
  • definitions.model.x-imports(当定义在dto上时,只会在该dto类中引入import)
  • paths.path.operation.x-imports(当定义在api中时,只会在该api中引入import)
说明:

在生成代码的时候,最终会有格式化的一个步骤,类上的无用import会被消除。

使用示例

swagger: "2.0"
info:
  description: ""
  version: "v1"
  title: "testSwagger"
  termsOfService: "http://www.coarl.org/service.html"
host: "git.huawei.com"
basePath: "/testswagger"
x-imports: 
  - "org.springframework.stereotype.Controller;" # 使用的时候结尾一定要带上 ;
  - "org.springframework.transaction.annotation.Transactional;"

使用效果:

使用前:api类中不生成org.springframework.stereotype.Controller; 和org.springframework.transaction.annotation.Transactional;引用。

使用后:api类中生成如下引用。

import org.springframework.stereotype.Controller;  # 通过x-import引入
import org.springframework.transaction.annotation.Transactional;  # 通过x-import引入

public interface CARDApi {
   -------
);

4、x-annotations

作用

添加指定的注解。

说明:

该标签用于在api的参数或者dto指定属性上添加注解。

标签值类型

List

使用位置

  • paths.path.operation.parameters.x-annotations(定义在api中的参数上时,只在此参数上生成对应的注解)
  • definitions.model.properties.property.x-annotations(定义在dto的字段上时,只在此字段上生成对应的注解)

使用示例

Card:
    type: "object"
    properties:
      id:
        type: "string"
        description: "id"
        example: "id"
      balance:
        type: "integer"
        format: "int64"
        description: "balance"
        example: 123
      address:
        type: "string"
        description: "address"
        example: "address"
        x-annotations:
          - "@InjectMocks"  # 此处在address属性上添加了一个 @InjectMocks 注解
        x-imports:
          - "org.mockito.InjectMocks;" # x-annotations实际是把 @InjectMocks当做字符串添加到了address上,所以需要自己通过x-imports导入相应的类      
      creator:
        type: "string"
        description: "creator"
        example: "creator"
      create_time:
        type: "string"
        format: "date-time"
        default: "CURRENT_TIMESTAMP"
        description: "create time"
        example: "2020-02-27 15:00:08"
      modify_time:
        type: "string"
        format: "date-time"
        default: "CURRENT_TIMESTAMP"
        description: "modified time"
        example: "2020-02-27 15:00:08"
      description:
        type: "string"
        description: "description info"
        example: "description"
    xml:
      name: "card"
      namespace: "com.huaweicloud.icsl.model"

使用效果:

使用前:

public class Card implements Serializable {
    private static final long serialVersionUID = 1L;

    -----

    @JsonProperty("address")
    private String address = null;

    ----
}

使用后:

public class Card implements Serializable {
    private static final long serialVersionUID = 1L;

    -------

    @JsonProperty("address")
    @InjectMocks   // 通过 x-annotations 引入的注解
    private String address = null;

    --------
}

5、x-class-annotations

作用

添加指定的注解。

说明:

该标签用于在api接口或者dto类上添加指定的注解。

标签值类型

List

使用位置

  • x-class-annotations(定义在swagger的最外层时,会在所有的api接口上都添加指定的注解)
  • components.schemas.model.x-class-annotations(定义dto对象上时,只在该对象上添加指定的注解)

使用示例

swagger: "2.0"
info:
  description: ""
  version: "v1"
  title: "testSwagger"
  termsOfService: "http://www.coarl.org/service.html"
host: "git.huawei.com"
basePath: "/testswagger"
x-imports: 
  - "org.springframework.stereotype.Controller;" # 使用的时候结尾一定要带上 ;
  - "org.springframework.transaction.annotation.Transactional;"
x-class-annotations: #此处添加的注解,在所有生成的api上都会添加
  - "@Controller" # 此处会将 @Controller识别为一个字符串添加到api接口类上,并不会导入相应的包,需要使用 x-imports标签手动导入相应的包
  - "@Transactional" # 此处会将 @Transactional识别为一个字符串添加到api接口类上,并不会导入相应的包,需要使用 x-imports标签手动导入相应的包

使用效果:

使用前:

package com.huaweicloud.icsl.api;

import ------

/**
 * CARDApi interface
 */
public interface CARDApi {
   -----------
}

使用后:

package com.huaweicloud.icsl.api;

import org.springframework.stereotype.Controller; // 通过x-imports 引入的导包
import org.springframework.transaction.annotation.Transactional; // 通过x-imports 引入的导包

/**
 * CARDApi interface
 */
@Controller  // 通过x-class-annotations 引入的注解
@Transactional // 通过x-class-annotations 引入的注解
public interface CARDApi {
   -----------
}

6、x-controller-annotations

作用

添加指定的注解。

说明:

该标签用于在api实现类上添加指定的注解。

标签值类型

String

使用位置

  • x-class-annotations(定义在swagger最外层,所有的api实现类上都会添加指定注解)
  • components.schemas.model.x-class-annotations(定义在指定tag下,只会在具体api实现类上添加指定注解)

使用示例

swagger: "2.0"
info:
  description: ""
  version: "v1"
  title: "testSwagger"
  termsOfService: "http://www.coarl.org/service.html"
host: "git.huawei.com"
basePath: "/testswagger"
x-imports: 
  - "org.springframework.context.annotation.Profile;" # 使用的时候结尾一定要带上 ;
x-controller-annotations: # 此处添加的注解,在所有生成的api实现类上都会添加,需要使用x-imports手动导入相应的包
  - '@Profile("test")'

使用效果:

使用前:

public class CardApiController implements CardApi {
     ------
}

使用后:

@Profile("test")   // 通过x-controller-annotations引入的注解
public class CardApiController implements CardApi {
     ------
}

7、x-method-annotations

作用

添加指定的注解。

说明:

该标签用于在api接口类中指定的api方法上添加注解。

标签值类型

List

使用位置

paths.path.operation.x-method-annotations(定义在指定api上,只在该api上添加相应注解)

使用示例

paths:
  /v1/cards/{card_id}:
    get:
      tags:
      - "CARD"
      summary: "通过Card的id查询Card"
      description: "Returns a single Card"
      operationId: "ShowCardById"
      x-is-registered: 'N'
      x-support-sdk: 'N'
      x-method-source: metadata
      x-method-annotations:
        - "@C" # 此处会将 @C识别为一个字符串添加到方法上,并不会导入相应的包,需要使用 x-imports标签手动导入相应的包
      x-imports:
        - "org.checkerframework.checker.units.qual.C;"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "card_id"
        in: "path"
        description: "card_id"
        required: true
        type: "string"
      responses:
        200:
          description: "successful operation"
          schema:
            $ref: "#/definitions/Card"
        404:
          description: "Card not found"

使用效果:

使用前:

ResponseEntity<Message<Card>> showCardById( @PathVariable("card_id") String cardId);

使用后:

@C  // 通过 x-method-annotations 引入的注解
ResponseEntity<Message<Card>> showCardById( @PathVariable("card_id") String cardId);

8、x-response-void

作用

设置api接口返回值为void。

标签值类型

Boolean

使用位置

paths.path.operation.x-response-void(定义在指定api上时,只会将该api的返回值设置为void)

说明:

当设置此值为true时,默认接口返回值为void,不再通过ResponseEntity包裹返回,默认值为false。

使用示例

paths:
  /v1/orders/{order_id}/order-details/{order_detail_id}:
    get:
      tags:
      - "Order"
      summary: "通过OrderDetail的id查询OrderDetail"
      description: "Returns a single OrderDetail"
      operationId: "ShowOrderDetailById"
      x-is-registered: 'N'
      x-support-sdk: 'N'
      x-response-void: true  # 此处指定了该接口的返回值为void,使用了此标签后,设置的responses将不会生效
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "order_id"
        in: "path"
        description: "order_id"
        required: true
        type: "string"
      - name: "order_detail_id"
        in: "path"
        description: "order_detail_id"
        required: true
        type: "string"
      responses:
        200:
          description: "successful operation"
          schema:
            $ref: "#/definitions/OrderDetail"
        404:
          description: "OrderDetail not found"

使用效果:

使用前:

ResponseEntity<Message<OrderDetail>> showOrderDetailById(@PathVariable("order_id") String orderId, @PathVariable("order_detail_id") String orderDetailId);

使用后:

void showOrderDetailById(@PathVariable("order_id") String orderId,  @PathVariable("order_detail_id") String orderDetailId)

9、x-type

作用

给dto的字段设置指定的类型。

标签值类型

String

使用位置

components.schemas.model.prorperties.field.x-type(设置在dto的指定字段上时,改变该字段的类型为指定类型)

使用示例

definitions:
  Contain:
    type: "object"
    x-generic: T
    x-extends: Parent
    properties:
      name:
        type: "string"
        description: ""
        example: 
      data:
        type: "string"
        x-type: T   # 通过x-type指定data的类型为T, 此处是将T当为一个字符串设置上,如果设置为一个对象时,需要使用x-imports手动导入相应的包
    xml:
      name: "Contain"
      namespace: "com.huaweicloud.icsl.app.dto"
        ---------------

使用效果:

使用前:

public class Contain implements Serializable {
    private static final long serialVersionUID = 1L;

    @JsonProperty("name")
    private String name = null;

    @JsonProperty("data")
    private String data = null;
}

使用后:

public class Contain implements Serializable {
    private static final long serialVersionUID = 1L;
    @JsonProperty("name")
    private String name = null;

    @JsonProperty("data")
    private T data = null;
}

10、x-generic

作用

为dto对象设置泛型。

说明:

一个对象仅能支持一个泛型参数。

标签值类型

String

使用位置

definitions.model.x-generic (在dto对象上设置后,只对该dto对象产生影响)

使用示例

Contain:
    type: "object"
    x-generic: T  # 此处通过x-generic为Contain对象设置泛型
    x-extends: Parent
    properties:
      name:
        type: "string"
        description: ""
        example: 
      data:
        type: "string"
        x-type: T  # 此处通过x-type为data字段设置为 T 泛型
    xml:
      name: "Contain"
      namespace: "com.huaweicloud.icsl.app.dto"

使用效果:

使用前:

public class Contain implements Serializable {
    private static final long serialVersionUID = 1L;

    @JsonProperty("name")
    private String name = null;

    @JsonProperty("data")
    private String data = null;
}

使用后:

public class Contain<T> implements Serializable {
    private static final long serialVersionUID = 1L;

    @JsonProperty("name")
    private String name = null;

    @JsonProperty("data")
    private T data = null;

}

11、x-extends

作用

为dto对象定义继承对象。

标签值类型

String

使用位置

definitions.model.x-extends (定义在dto对象上时,只为该对象添加继承)

使用示例

Contain:
    type: "object"
    x-generic: T
    x-extends: Parent  # 此处使用 x-extends标签让Contain继承Parent,Parent和Contain对象定义在同一个类中,当引入的是一个三方类的时候需要使用x-imports手动导包
    properties:
      name:
        type: "string"
        description: ""
        example: 
      data:
        type: "string"
        x-type: T
    xml:
      name: "Contain"
      namespace: "com.huaweicloud.icsl.app.dto"

使用效果:

使用前:

public class Contain<T> implements Serializable {
    private static final long serialVersionUID = 1L;

    @JsonProperty("name")
    private String name = null;

    @JsonProperty("data")
    private T data = null;
}

使用后:

public class Contain<T> extends Parent implements Serializable {
    private static final long serialVersionUID = 1L;
    @JsonProperty("name")
    private String name = null;

    @JsonProperty("data")
    private T data = null;
}

12、x-returnType

作用

定义方法的返回值类型。

标签值类型

String

使用位置

paths.path.operation.x-returnType (定义在指定api上时,只影响该api的返回值)

使用示例

paths:
  /v1/cards/{card_id}:
    delete:
      tags:
      - "CARD"
      summary: "通过Card的id删除Card"
      description: "Delete a single Card"
      operationId: "DeleteCardById"
      x-is-registered: 'N'
      x-support-sdk: 'N'
      x-method-source: metadata
      x-returnType: Contain<Card>  # 此处使用x-returnType指定了方法的返回值为Contain<Card>
      x-imports:
        - "com.huaweicloud.icsl.app.customdto.Contain;" # 返回值引入了一个三方对象,需要使用 x-imports标签手动导入包
      parameters:
      - name: "card_id"
        in: "path"
        description: "card_id"
        required: true
        type: "string"
      responses:
        200:
          description: "successful operation"
          schema:
            type: "integer"
            format: "int32"
        404:
          description: "Card not found"

使用效果:

使用前:

ResponseEntity<Message<Integer>> deleteCardById(@PathVariable("card_id") String cardId);

使用后:

ResponseEntity<Message<Contain<Card>>> deleteCardById(@PathVariable("card_id") String cardId);

13、x-exception

作用

自定义api抛出的异常类。

标签值类型

String

使用位置

x-exception(定义在swagger的最外层,使用此标签后,所有的api中都会抛出此异常)

说明:

该标签通常要配置x-imports一起使用。

使用示例

swagger: "2.0"
info:
  description: ""
  version: "v1"
  title: "testSwagger"
  termsOfService: "http://www.coarl.org/service.html"
host: "git.huawei.com"
basePath: "/testswagger"
x-exception: "org.springframework.validation.BindException" #所有的api中都会抛出该异常
x-imports: 
  - "org.springframework.validation.BindException;"

使用效果:

使用前:

ResponseEntity<Message<Card>> addCard(@Valid @RequestBody Card body);

使用后:

ResponseEntity<Message<Card>> addCard( @RequestBody Card body) throws BindException;

14、x-keep-original-tagname

作用

是否保持swagger中tag的原名称。

说明:

AstroPro生成代码的时候,接口所在类的名称采用tag的驼峰格式+相应的后缀,当用户不想将tag转换为驼峰时可以使用此标签。

标签值类型

boolean

使用位置

x-keep-original-tagname (在swagger最外层使用)

说明:

swagger中用户定义的tag名存在专有名词需要全大写;AstroPro默认会将全大写的转为驼峰。

使用示例

swagger: "2.0"
info:
  description: ""
  version: "v1"
  title: "testSwagger"
  termsOfService: "http://www.coarl.org/service.html"
host: "git.huawei.com"
basePath: "/testswagger"
x-keep-original-tagname: true
  /v1/cards:
    post:
      tags:
      - "CARD"  # 此处指定了  /v1/cards接口生成在 CARDxxxx的接口类中
      --------

使用效果:

使用前:

public interface CardApi {
    ResponseEntity<Message<Card>> addCard(@RequestBody Card body);
}

使用后:

public interface CARDApi {
    ResponseEntity<Message<Card>> addCard(@RequestBody Card body);
}

15、x-enum-value-type

作用

用于标识定义的枚举的value的数据类型。

标签值类型

String

使用位置

definitions.model.x-enum-value-type (定义在指定枚举对象上时,只对该枚举对象产生影响)

说明:

可选值有"STRING", "LONG", "INTEGER", "FLOAT", "DOUBLE", "BOOLEAN",默认为"STRING"。

使用示例

definitions:
  Code:
    type: "string"
    enum: &Code
      - STARTING("1")
      - SELECTING("2")
      - PAYING("3")
      - PAYED("4")
    x-enum-value-type: "LONG"
    xml:
      name: "Code"
      namespace: ""

使用效果:

使用前:

public enum Code implements IEnum<String> {
    ----
    PAYED("4");

    Code(String value) {
        this.value = value;
    }

    private final String value;  # 此处类型为String

    @JsonValue
    public String getValue() {
        return value;
    }

    @JsonCreator
    public static Code fromValue(String value) {
        for (Code b : Code.values()) {
            if (String.valueOf(b.value).equals(value)) {
                return b;
            }
        }
        return null;
    }
}

使用后:

public enum Code implements IEnum<String> {
    ----
    PAYED("4");

    Code(String value) {
        this.value = value;
    }

    private final Long value;  # 此处类型为Long

    @JsonValue
    public String getValue() {
        return value;
    }

    @JsonCreator
    public static Code fromValue(String value) {
        for (Code b : Code.values()) {
            if (String.valueOf(b.value).equals(value)) {
                return b;
            }
        }
        return null;
    }
}

16、x-enum-class-name

作用

用于标识查询参数对应的枚举类。

标签值类型

String

使用位置

paths.path.operation.parameters.fields.x-enum-value-type

说明:

对应的是swagger中已定义的枚举对象名字。

使用示例

Paths:  
  /v1/orders/{order_id}/order-details:
    get:
      tags:
      - "Order"
      summary: "查询OrderDetail"
      description: "Returns OrderDetail"
      operationId: "ListOrderDetails"
      x-is-registered: 'N'
      x-support-sdk: 'N'
      x-mybatis-paging: true
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "status"
        in: "query"
        description: "status"
        required: false
        type: "string"
        x-enum-class-name: "OrderStatus" #此标签只在查询参数中使用
       --------

使用效果:

使用前:

public class ListOrderDetailsQo implements Serializable {
    private static final long serialVersionUID = 1L;
    @JsonProperty("status")
    private Object status = null;

   -------------------
}

使用后:

public class ListOrderDetailsQo implements Serializable {
    private static final long serialVersionUID = 1L;
    @JsonProperty("status")
    private OrderStatus status = null;

   -------------------
}

17、x-entity-package

作用

用于在swagger中指定实体类dto生成的包名。

标签值类型

String

使用位置

x-entity-package(定义在swagger的最外层)

使用示例

swagger: "2.0"
info:
  description: ""
  version: "v1"
  title: "testSwagger"
  termsOfService: "http://www.coarl.org/service.html"
host: "git.huawei.com"
basePath: "/testswagger"
x-entity-package: "customdto"
    ------------

使用效果:

使用前:

#dto对象生成目录 xxx.xx.xx.dto

使用后:

#dto对象生成目录 xxx.xx.xx.customdto

18、x-interface-name-style

作用

控制自定义接口、实现类命名风格。

标签值类型

enum(DEFAULT,SERVICE_IMPL_AND_NO_I_INTERFACE_PREFIX),配置为DEFAULT时和不配置此参数效果相同。

使用位置

x-interface-name-style

使用示例

swagger: "2.0"
info:
  description: ""
  version: "v1"
  title: "testSwagger"
  termsOfService: "http://www.coarl.org/service.html"
host: "git.huawei.com"
basePath: "/testswagger"
x-entity-package: "customdto"
x-interface-name-style: SERVICE_IMPL_AND_NO_I_INTERFACE_PREFIX
    ------------

使用效果:

使用前:

service类的命名为 I+tag驼峰+ service
eg: IOrderService

使用后:

service类的命名为 tag驼峰+ service
eg: OrderService

19、x-user-defined-produces

作用

按照用户定义的produces生成代码。

标签值类型

Boolean

使用位置

x-user-defined-produces(定义在swagger最外层)

使用示例

swagger: "2.0"
info:
  description: ""
  version: "v1"
  title: "testSwagger"
  termsOfService: "http://www.coarl.org/service.html"
host: "git.huawei.com"
basePath: "/testswagger"
x-entity-package: "customdto"
x-interface-name-style: SERVICE_IMPL_AND_NO_I_INTERFACE_PREFIX
x-user-defined-produces: true
    ----
paths:
  /v1/cards/{card_id}:
    delete:
      tags:
      - "CARD"
      summary: "通过Card的id删除Card"
      description: "Delete a single Card"
      operationId: "DeleteCardById"
      x-is-registered: 'N'
      x-support-sdk: 'N'
      x-method-source: metadata
      x-returnType: Contain<Card>
      # 未在接口中定义produces标签
      -------

使用效果:

使用前:

@RequestMapping(value = "/v1/cards/{card_id}", produces = {"*/*"}, method = RequestMethod.DELETE)
    ResponseEntity<Message<Integer>> deleteCardById( @PathVariable("card_id") String cardId);

使用后:

@RequestMapping(value = "/v1/cards/{card_id}", method = RequestMethod.DELETE)
    ResponseEntity<Message<Contain<Card>>> deleteCardById(@PathVariable("card_id") String cardId);

20、x-user-defined-consumes

作用

按照用户定义的consumes生成代码。

标签值类型

Boolean

使用位置

x-user-defined-consumes(定义在swagger最外层)

使用示例

swagger: "2.0"
info:
  description: ""
  version: "v1"
  title: "testSwagger"
  termsOfService: "http://www.coarl.org/service.html"
host: "git.huawei.com"
basePath: "/testswagger"
x-entity-package: "customdto"
x-interface-name-style: SERVICE_IMPL_AND_NO_I_INTERFACE_PREFIX
x-user-defined-consumes: true
    ----
paths:
  /v1/cards/{card_id}:
    delete:
      tags:
      - "CARD"
      summary: "通过Card的id删除Card"
      description: "Delete a single Card"
      operationId: "DeleteCardById"
      x-is-registered: 'N'
      x-support-sdk: 'N'
      x-method-source: metadata
      x-returnType: Contain<Card>
      # 未在接口中定义consumes标签
      -------

使用效果:

使用前:

@RequestMapping(value = "/v1/cards/{card_id}", consumes= {"*/*"}, method = RequestMethod.DELETE)
    ResponseEntity<Message<Integer>> deleteCardById( @PathVariable("card_id") String cardId);

使用后:当path未定义consumes时,不生成consumes。

@RequestMapping(value = "/v1/cards/{card_id}", method = RequestMethod.DELETE)
    ResponseEntity<Message<Contain<Card>>> deleteCardById(@PathVariable("card_id") String cardId);

21、x-pom-gav

作用

自定义标签-pom坐标引入。

标签值类型

List

使用位置

x-pom-gav

components.schemas.model.x-pom-gav

components.schemas.model.properties.property.x-pom-gav

paths.path.operation.x-pom-gav

paths.path.operation.parameters.name.x-pom-gav

说明:

x-pom-gav在Swagger文件中的位置可以是类级别、方法级别、参数级别,groupId、artifactId、version按照顺序用:连接,全局有一个地方定义即可,不需要重复定义。

使用示例

swagger: "2.0"
info:
  description: ""
  version: "v1"
  title: "testSwagger"
  termsOfService: "http://www.coarl.org/service.html"
host: "git.huawei.com"
basePath: "/testswagger"
x-entity-package: "customdto"
x-interface-name-style: SERVICE_IMPL_AND_NO_I_INTERFACE_PREFIX
x-user-defined-consumes: true
x-pom-gav:   # 手动引入hibernate-validator:依赖
  - "org.hibernate.validator:hibernate-validator:8.0.1.Final"
-------

使用效果:

使用前:

pom中没有org.hibernate.validator:hibernate-validator:8.0.1.Final的依赖

使用后:

pom中生成org.hibernate.validator:hibernate-validator:8.0.1.Final的依赖
提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容