1.0.1 • Published 2 years ago
px-request v1.0.1
px-request
功能
- 判断 ts 入参和返回类型
- 业务错误判断
- 全自动 mock
用法
常规
import pxRequst from "px-request";
const data = await pxRequest(apiConfig());
console.log(data);
其中 apiConfig 建议使用 px-fman
开发工具自动生成。
Mock
px-request 采用基于 faker 的 mock 数据方案。
接口文件中新增定义(或通过 px-fman 根据接口返回类型自动生成):
// 定义文件
import { MockData } from "px-request";
const mockData: MockData = {
firstPage: "id",
hasNextPage: "boolean",
result: [
{
count: "number",
uid: "id",
uploadTime: "string",
userName: "name",
userUid: "id",
},
],
totalCount: "number",
};
export default (params: QueryType & ParamsType) => {
return {
request: {
// ...
},
response: {} as ResponseType,
mockData,
};
};
开启 mock 配置:
// 在业务中
import pxRequst from "px-request";
const data = await pxRequest(apiConfig(), { mock: true }); // 开启 mock
console.log(data);
px-request 会自动返回从 faker 中生成的随机数据。
如果想要自定义返回数据的话,可以将类型替换为函数。
目前支持以下类型:
type MockType =
| "string"
| "number"
| "boolean"
| "id"
| "phone"
| "name"
| "image"
| ((faker: Faker) => string);
更多 faker 方法参考文档:https://fakerjs.dev/api/random.html