毛利率|艾思软件开发部接口(Json)通用性开发文档说明智能硬件|营收|VR

路由定义:
框架使用多应用默认路由模式; url三部分组成格式为: /模块名称/控制器名称/方法名称;
如 /core/Config/lists: 即为平台核心模块/config控制器/lists方法.
接口请求分类:
接口分为两种类型: 命令型和获取数据型;
命令型接口如添删改接口这种接口data字段一般为空数组;
获取数据型如查询接口这种接口status值总是1 info字段只是给前端开发人员做个提示数据到底是否获取成功需要再判断data的值是否为空数组;
数据提交方式:
框架使用最宽泛的方式支持所有的提交方式并且不做提交方法的判断. 请求到底是要干什么不是根据请求方式进行判断而是使用方法名进行判断.
一般情况在后端开发调试过程中直接使用GET方式在URL中传参更加方便; 对于前端开发人员使用POST和GET方式都可以根据实际情况以快捷方便为原则进行选择即可(但是在一定程度上要统一要封装建议全部使用POST);
特殊情况比仿说要传递大量数据的如text字段/文章正文内容/文件上传等酌情处理(POST);
常用控制器方法命名规范:

添加/保存: edit
查询单条数据: detail
分页列表: lists
删除: del
不分页列表: ls (注意当表内数据过多比仿说超过50条时谨慎使用因为此方法是返回表内所有的数据)
查询前20条列表: search

数据返回字段格式:
数据返回统一使用JSON格式. 所有接口都包含三个字段. [‘status' : ‘int 状态码’ 'info' : ‘string 信息说明’ 'data' : ‘array/array object 数据集’
数据返回字段详细说明:

status: 接口状态 int类型值为0 1 2 其它.
命令型接口当值为0时表示操作失败为1时表示操作成功 2为token过期其它自定义
获取数据型执行成功并不意为着能得到数据如detail接口返回的status值总是是1 但是data数据有可能返回空数组. 所以强类型语言下前端在获取数据后有可能需要再对data字段进行是否为空数组的判断否则会出现用户提示查询成功但是没有内容的情况.
info: 接口信息的说明 string类型.
一般情况下这个字段是给用户的操作结果的提示语如删除成功删除失败的提示.如果是获取数据一般情况下 status值为1时 info字段不用展示给用户前端开发时做为提示即可;
data: 接口返回的数据集合数组或数组对象.
命令类型接口时一般返回空数组忽略即可.
获取数据型时返回数组或数组对象数据格式为三种;

data字段的三种格式:

单条数据格式返回的是数组对象如detail接口需要传递要查询的表id

{
\"status\": 1
\"info\": \"数据列表\"
\"data\": {
\"id\": 2
\"name\": \"普通会员\"
\"sort\": 3

2. 多条数据格式返回的是数组对象如ls接口; (包含多维数组的情况子数组以_child命名不再举例)
{
\"status\": 1
\"info\": \"数据列表\"
\"data\": [
{
\"id\": 2
\"name\": \"普通会员\"