@shanghailz/request

lz-request：丽章 http 请求库

介绍

lz-request 包含了一组丽章后端通用的 api:

• getTable：获取表格数据
• getSubTable：获取子表数据
• addRecords：添加记录
• modifyRecords：修改记录
• removeRecords：移除记录
• clearCache：清除后端缓存
• ...

/**
 * api.js 文件
 * */
import http from 'lz-request';
// ...
export default http;

// ===================================================

/**
 * example.js 文件：使用通用的 api
 * */
import http from './api';
// ...
let res;
try {
  // 使用通用 api getTable 来获取资源 id 为 5050505050 表的数据
  res = await http().getTable({
    resid: 5050505050
  });
} catch (err) {
  return console.error(err);
}
//...

以及一套扩展 特定项目的定制 api 的方法：

// 例如：在 powerworks 项目中，需要定义一个 api，来获取网页头部的提醒数量

/**
 * api.js 文件
 * */
import http from 'lz-request';

// 设置默认的基地址
http.setDefaultBaseURL('http://localhost:8080/');

// 设置默认的请求头
http.setDefaultHeaders({
  'Content-Type': 'application/json'
});

// 创建定制的获取提醒数量的 api，方法名为 'getReminderNum'
http.createApi('getReminderNum', {
  method: 'get',
  url: '/api/Resource/RetrieveReminderNum'
});

export default http;

// ===================================================

/**
 * 在 header.js 组件中使用
 * */
import http from './api';
// ...

let res;
try {
  // 使用在 api.js 文件中创造出来的定制 api：getReminderNum()
  res = await http().getReminderNum();
} catch (err) {
  return console.error(err);
}

//...

安装

npm i --save @powerworks/lz-request

通用设置方法

1. http.setDefaultBaseURL

通用 api

1. getTable(params)：get 请求，获取表数据

await getTable({
  resid, // 资源 id：必填项
  subresid, // 子表资源 id
  cmswhere, // where 语句
  hostrecid, // 记录 REC_ID
  sortOrder, // 排序
  sortField, // 排序字段
  key, // 模块查询
  cmscolumns, // 主表按需要的字段返回数据，字段之间使用 "," 隔开
  getcolumninfo, // 是否返回字段定义：默认 '0'，不返回字段定义；'1' 返回字段定义
  pageindex, // 分页页码：默认 0 ，不分页
  pagesize, // 分页大小
  subcmscolumns // 子表按需要的字段返回数据，字段之间使用 "," 隔开
})

2. getSubTable(params)：get 请求，获取子表数据

await getSubTable({});