资讯评论 - Torna Swagger 插件 1.2.10 发布，Swagger 增强利器 - OSCHINA

Torna Swagger 插件 1.2.10 发布，Swagger 增强利器

Torna Swagger 插件 1.2.10 发布，本次更新内容如下：

- 支持定义错误码 doc

在配置文件中新增codes节点，用来定义错误码或者枚举

// 定义全局错误码，也可以定义枚举
  "codes": [
    // 每一项表示一个分组
    // 定义错误码
    {
      "name": "错误码", // 分组名称
      "description": "这里是全局错误码", // 错误码描述
      "itemType": "string", // 错误码类型
      "items": [
        { "value": "W_10001", "description": "参数错误" },
        { "value": "W_10002", "description": "缺少token" },
        { "value": 10000, "type": "number", "description": "缺少参数" } // 单独指定类型
      ]
    },
    // 定义枚举
    {
      "name": "订单状态枚举",
      "itemType": "number",
      "items": [
        { "name": "WAIT_PAY", "value": 0, "description": "未支付" },
        { "name": "HAS_PAY", "value": 1, "description": "已支付" },
        { "name": "CANCEL", "value": 2, "description": "取消支付" }
      ]
    },
    {
      "name": "用户状态",
      "itemType": "number",
      "items": [
        { "name": "ENABLE", "value": 1, "description": "启用" },
        { "name": "DISABLE", "value": 0, "description": "禁用" }
      ]
    }
  ]

推送到Torna后台，将会看到定义后的内容。

关于Torna Swagger

Torna配套Swagger插件，可以将代码中申明的swagger注解文档推送到Torna平台，统一进行管理。

使用Torna Swagger插件的好处有：

不用启动项目即可查看文档，调试接口
可区分多环境调试（开发环境、测试环境）
项目中只需要依赖swagger注解jar即可
可定义第三方jar中没有写注解的类

Torna Swagger 插件 1.2.10 发布，Swagger 增强利器

暂无更多评论