美文网首页
接口设计

接口设计

作者: 一家之主小书童 | 来源:发表于2018-11-28 10:48 被阅读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",
}

相关文章

  • 2018-05-16

    #接口测试用例设计-博客-云栖社区-阿里云 #### 接口测试用例设计一 ##### 1、接口测试概念 接口...

  • 接口设计评审规范

    接口设计评审规范 前言 本接口设计规范,参考了restfull的部分设计理念。 以资源为中心的接口设计 资源是 R...

  • 19年第34周:Go语言 有趣的接口

    一、Golang的接口 Go语言接口设计很符合设计原则参考图灵丛书中的《设计模式》 当我看到Golang的接口时,...

  • 接口安全设计-签名机制

    接口安全设计-签名设计 签名设计主要围绕Timestamp和Sign机制展开设计,保证接口的数据不会被篡改。 签名...

  • 软件设计模式-接口隔离

    这个原则是 明确了 如何设计对接口!怎么用接口。 从前面开始我们就知道了接口的好处,如何设计好的接口呢?那么接口隔...

  • 2018-01-29

    pojo类、接口、接口的实现类 接口设计不关注具体怎么实现,只关心需要哪些接口(需求,业务逻辑设计),需要什么参数...

  • 2020-07-02

    浅谈 浅谈模块设计宏内核 浅谈接口设计Flags 浅谈稳定性设计重试 浅谈人员业务结构设计矩阵式 浅谈接口设计 |...

  • 接口设计

    1.通用参数:header 2.接口定义 2.1获得收入类型 url:/income/type/list meth...

  • 接口设计

    编程的基本原则: 接口基本原则: 接口规范 接口示例:以获取个人信息1.极简且完备: 不要冗余 不要缺失 2.语义...

  • 领域驱动设计(DDD):领域接口化设计

    领域接口化设计 把服务对象(service)和资源库对象(repository)设计成接口是最常见的。但是这对接口...

网友评论

      本文标题:接口设计

      本文链接:https://www.haomeiwen.com/subject/jrooqqtx.html