德昂接口文档

列表项
德昂 1.0

1、项目约定

1.1 基本约定

1.1.1 API Base Url

• 【测试url】待定
• 【线上url】/api

1.1.2 鉴权字段(身份标识)

• X-auth-token : [string] 登录后获取的 token 信息, 请求头带此字段

1.1.3 HTTP请求中字段要求

• POST请求Content-Type为：Content-Type:application/x-www-form-urlencoded
• 文件上传时Content-Type为：Content-Type:multipart/form-data
• 对于：Content-Type:application/json：Content-Type:application/xml不保证完全支持，请谨慎使用

1.2 通用接口

1.2.1 验证码图片

注：请求图片时，需解析图片的cookie，不然无法认证

GET
/captcha

1.3 通用响应字段

1.3.1 状态字段

• code: [int] 服务器状态码，0 为正常状态，异常状态待定。
• msg：[string] 错误信息，但 code 不为 0 时返回
• data：[object] 数据

1.3.2 数据字段

• data: [object] 数据字段，所有响应数据都在此字段中
• list: [array]，当返回数据为列表时会将数据放在该字段

1.3.3 分页字段

• page: [int] 当前页码，默认为1
• total: [int] 总页数
• pageSize: [int]
  每页数量：本项目常用page_size==10

示例

{
    status: 0,
    msg: '',
    data: {
        list: [{
            key: value
        }],
        total: 23
    }
}

2、数据结构

2.1 常用字段含义

无

2.2 核心结构

2.2.1 用户基本信息 （v2.0修改）

{
    id: 123,
    nick_name: '梦里花落知多少',
    real_name: 'xx',
    phone: '15500000000',
    sex: 1,
    avatars: 'http://image.com/1.jpeg',
}

• id: [int] 用户ID
• nick_name: [string] 用户名
• phone: [string] 用户手机
• avatars: [string] 头像
• real_name: [string] 姓名

2.2.2 报表

{
    "id": 1,
    "adminId": 1,
    "reportName": "test",
    "reportUrl": "test",
    "libraryUrl": "tse",
    "reportPhotoUrl": "tse",
    "description": "tse",
}

• id: [int] 订单ID
• reportName: [string] 报表名称
• reportUrl: [date] 报表地址
• libraryUrl: [date] 库地址
• reportPhotoUrl: [integer] 图片
• description: [obj] 报表描述

3、接口列表

3.1 用户类

3.1.1 登录

请求URL

POST
/api/auth/login

请求参数

• username: [string] 用户名 【必填】
• pwd: [string] 密码 【必填】
• captchaCode: [string] 图片校验码 【必填】

响应

{
    "status": 0,
    "msg": "",
    "data":{
        @用户基本信息
    }
}

3.2 报表接口

3.2.1 获得报表列表

请求URL

GET
/api/report

请求头上需要带上x-auth-token

返回该用户所有报表

响应

{
    "status": 0,
    "msg": "",
    "data": [
        @报表信息
    ]
}