华为云首页用户手册

Astro企业应用 AstroPro-swagger标签使用指南:16、x-enum-class-name

时间：2025-02-12 15:02:26

Astro企业应用 AstroPro 导入swagger

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;   -------------------}

上一篇：Astro企业应用 AstroPro-swagger标签使用指南:9、x-type

下一篇：Astro企业应用 AstroPro-swagger标签使用指南:2、x-default-empty