接口设计

2018-11-28  本文已影响0人  一家之主小书童

1.通用参数:header

名称 类型 说明
familyId int 家庭id

2.接口定义

2.1获得收入类型

url:/income/type/list

method:GET

入参: 通用参数

返回示例

{
    "code": "0",
    "msg": "success",
    "data": {
        "item": [
            {
                "id": 0,
                "typeName": "工资"
            },
            {
                "id": 1,
                "typeName": "奖金"
            },
          {
                "id": 2,
                "typeName": "投资收入"
            }
        ]
    }
}

2.2获得支出类型

url:/cost/type/list

method:GET

入参:

名称 类型 说明
costTypeId int 如果空获得第一级支出类型

返回示例:

{
    "code": "0",
    "msg": "success",
    "data": {
        "item": [
            {
                "id": 0,
                "costName": "衣"
            },
            {
                "id": 1,
                "costName": "食"
            },
           {
                "id": 2,
                "costName": "住"
            },
           {
                "id": 3,
                "costName": "行"
            },
           {
                "id": 4,
                "costName": "教育"
            },
           {
                "id": 4,
                "costName": "娱乐"
            } 
        ]
    }
}

2.3添加收入

url:/income/add

method:POST

Content-Type:application/x-www-form-urlencoded

参数说明:

名称 类型 说明
userId int 用户Id
incomeTypeId int 收入类型
incomeTime long 收入时间
money double 收入金额

返回示例:

{
    "code": "0",
    "msg": "success",
}

2.4添加支出

url:/cost/add

method:POST

Content-Type:application/x-www-form-urlencoded

参数说明

名称 类型 说明
targetType int 0:家庭1:个人
userId int 用户Id targetType为1该字段有效
costTypeId int 支出类型
costTime long 支出时间
money double 支出金额
remark String 备注

返回示例:

{
    "code": "0",
    "msg": "success",
}
上一篇 下一篇

猜你喜欢

热点阅读