• 前后分离接口规范


    1. 开发流程

    1. 后端编写和维护接口文档,在 API 变化时更新接口文档
    2. 后端根据接口文档进行接口开发
    3. 前端根据接口文档进行开发 + Mock平台
    4. 开发完成后联调和提交测试

    Mock 服务器根据接口文档自动生成 Mock 数据,实现了接口文档即API:

     
    开发流程

    2. 具体实施

    现在已基本完成了,接口方面的实施:

    1. 接口文档服务器:可实现接口变更实时同步给前端展示;
    2. Mock接口数据平台:可实现接口变更实时Mock数据给前端使用;
    3. 接口规范定义:很重要,接口定义的好坏直接影响到前端的工作量和实现逻辑;具体定义规范见下节;
     
    接口文档+Mock平台服务器

    3. 接口规范V1.0.0

    3.1 规范原则

    1. 接口返回数据即显示:前端仅做渲染逻辑处理;
    2. 渲染逻辑禁止跨多个接口调用;
    3. 前端关注交互、渲染逻辑,尽量避免业务逻辑处理的出现;
    4. 请求响应传输数据格式:JSON,JSON数据尽量简单轻量,避免多级JSON的出现;

    3.2 基本格式

    3.2.1 请求基本格式

    GET请求、POST请求==必须包含key为body的入参,所有请求数据包装为JSON格式,并存放到入参body中==,示例如下:

    1. GET请求:

    xxx/login?body={"username":"admin","password":"123456","captcha":"scfd","rememberMe":1}

    1. POST请求:
       
      POST请求

    3.2.2 响应基本格式

    {
        code: 200,
        data: {
            message: "success"
        }
    }
    
    1. code : 请求处理状态

    200: 请求处理成功

    500: 请求处理失败

    401: 请求未认证,跳转登录页

    406: 请求未授权,跳转未授权提示页

    1. data.message: 请求处理消息

    code=200 且 data.message="success": 请求处理成功

    code=200 且 data.message!="success": 请求处理成功, 普通消息提示:message内容

    code=500: 请求处理失败,警告消息提示:message内容

    3.3 响应实体格式

    {
        code: 200,
        data: {
            message: "success",
            entity: {
                id: 1,
                name: "XXX",
                code: "XXX"
            }
        }
    }
    

    data.entity: 响应返回的实体数据

    3.4 响应列表格式

    {
        code: 200,
        data: {
            message: "success",
            list: [
                {
                    id: 1,
                    name: "XXX",
                    code: "XXX"
                },
                {
                    id: 2,
                    name: "XXX",
                    code: "XXX"
                }
            ]
        }
    }
    

    data.list: 响应返回的列表数据

    3.5 响应分页格式

    {
        code: 200,
        data: {
            recordCount: 2,
            message: "success",
            totalCount: 2,
            pageNo: 1,
            pageSize: 10,
            list: [
                {
                    id: 1,
                    name: "XXX",
                    code: "H001"
                },
                {
                    id: 2,
                    name: "XXX",
                    code: "H001"
                } ],
            totalPage: 1
        }
    }
    

    data.recordCount: 当前页记录数
    data.totalCount: 总记录数
    data.pageNo: 当前页码
    data.pageSize: 每页大小
    data.totalPage: 总页数

    3.6 特殊内容规范

    3.6.1 下拉框、复选框、单选框

    由后端接口统一逻辑判定是否选中,通过isSelect标示是否选中,示例如下:

    {
        code: 200,
        data: {
            message: "success",
            list: [{
                id: 1,
                name: "XXX",
                code: "XXX",
                isSelect: 1
            }, {
                id: 1,
                name: "XXX",
                code: "XXX",
                isSelect: 0
            }]
        }
    }
    

    禁止下拉框、复选框、单选框判定选中逻辑由前端来处理,统一由后端逻辑判定选中返回给前端展示;

    3.6.2 Boolean类型

    关于Boolean类型,JSON数据传输中一律使用1/0来标示,1为是/True,0为否/False;

    3.6.3 日期类型

    关于日期类型,JSON数据传输中一律使用字符串,具体日期格式因业务而定;

     

  • 相关阅读:
    调试tomcat的过滤器配置
    嵌入式实操----基于RT1170 FreeRTOS时定器接口封装(二十二)
    嵌入式实操----基于RT1170 首板硬件之tempsensor温度传感器调试(二十一)
    嵌入式实操----基于RT1170 首板硬件之第一阶段总结(十九)
    嵌入式实操----基于RT1170 首板硬件之WDT调试(二十)
    嵌入式实操----基于RT1170 首板硬件之CAN BUS TJA1043显示调试(十八)
    嵌入式实操----基于RT1170 首板硬件之MIPI显示调试(十七)
    嵌入式实操----基于RT1170 首板硬件之ADC调试(十六)
    嵌入式实操----基于RT1170 首板硬件之EEPROM AT24C16调试(十五)
    嵌入式实操----基于RT1170 首板硬件之QSPI Flash调试(十三)
  • 原文地址:https://www.cnblogs.com/linjiaxin/p/10578174.html
Copyright © 2020-2023  润新知