apidoc

发表于 | 分类于

Api doc

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/**
     * @api {post} / 充值
     * @apiVersion 1.0.0
     * @apiName deposit
     * @apiDescription 充值
     * @apiGroup Accounting
     * @apiParam (Headers) {String} version 版本
     * @apiParam (body) {String} userId
     * @apiParam (body) {Double} fee
     * @apiSuccess {Object} response
     * @apiSuccess {String} response.err 业务错误码
     * @apiSuccess {String} response.message 错误消息
     * @apiSuccess {Object} response.data 响应数据
     * @apiSuccess {String} response.data.transSeq
     */

Common doc

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

/**
 *
 *  @apiGroup --Preface--
 *  @apiDescription 前言
 *  @api {get} /
 *
 *
 *  @apiDescription 资源说明
 *  @apiErrorExample  DigitalCurrency

    {
      "id": "uuid",
      "name": "string",
      "withdrawal_rate": "float 提款手续费",
      "currency_id": "int Account MS currency id",
      "deposit_rate": "float 存款手续费",
      "status": "string"
           "ACTIVE"    <==>
           "DISABLED"  <==>
      "created_at": "datetime 创建时间",
      "updated_at": "datetime 最近更新时间",
      "creator_id": "uuid, 创建用户id"
    }

 *  @apiErrorExample  ReceiveAddress
   {
     "id": "uuid",
     "name": "string, 数字货币名称",
     "address": "string",
     "userid": "uuid, 关联用户id, 默认为null",
     "creator_id": "uuid, 创建用户id",
     "status": "string",
          "ACTIVE"    <==>
          "DISABLED"  <==>
     "created_at": "datetime, 创建时间",
     "digital_currency_id": "uuid, 关联数字货币id"
   }

 *  @apiErrorExample  WithdrawalAddress
   {
     "id": "uuid",
     "address": "string",
     "userid": "uuid, 关联用户id, 默认为null",
     "label": "string, 用户自定义标签",
     "status": "string",
          "ACTIVE"    <==>
          "DISABLED"  <==>
     "created_at": "datetime, 创建时间",
     "digital_currency_id": "uuid, 关联数字货币id"
   }
 */