merchant-fe-doc

merchant-fe-doc

  • Docs

›接口调用

开发须知

  • 概述

新增页面

  • 概述

表单

  • q-antd
  • 各表单元素
  • Form

组件

  • Pagination_

接口调用

  • 概述

Q

  • 命名空间Q

接口调用

在common/util的ajax中封装了packingjs,统一处理了错误,增加了mock等,并将其挂载到Q命名空间上方便调用

使用步骤

  • 每个页面中新建一个api.js,此页面的所有请求都通过Q.ajax.setup在此配置
  • 在业务页面引入api.js,通过Q.ajax(AJAX_NAME, param)来调用

示例

假如目录结构如下

+--notice
|----api.js
|----app.js
|----index.js

notice/api.js代码如下

Q.ajax.setup(false, {
  FETCH_LIST: {
    url: 'xxxx',
    ajaxType: Q.ajaxType.GET,
    tip: false,
    mock: {
      ret: true,
      msg: '',
      data: {
        total: 100,
        list: [{
          id: 1
        }]
      }
    }
  }
})

notice/app.js代码如下

Q.ajax('FETCH_LIST', {seq: 'xxx'}).then((res)=>{
  //业务代码
})

Q.ajax.setup配置属性

以下只展示了自定义封装属性以及部分ajax属性,其他属性参考jquery的ajax配置

url

请求路径

typedefault
string-

ajaxType

请求type

typedefault
objectQ.ajaxType.GET

tip

是否展示消息

typedefault
stringtrue

loading

是否全局展示加载中cover

typedefault
boolfalse

mock

mock数据对象

typedefault
ObjectArray-

preprocess

预处理函数

typedefault
function-

lock

锁定,锁定之后在同一个请求返回之前不会发送第二次请求

typedefault
booltrue

succMsg

成功消息

typedefault
string-

failMsg

失败消息

typedefault
string-
← Pagination_命名空间Q →
  • 使用步骤
  • 示例
  • Q.ajax.setup配置属性
    • url
    • ajaxType
    • tip
    • loading
    • mock
    • preprocess
    • lock
    • succMsg
    • failMsg