1.0.10 • Published 8 months ago

npm-kpocom-mis5-api v1.0.10

Weekly downloads
-
License
ISC
Repository
-
Last release
8 months ago

使用手册

视频教程

  1. 在源码目录下(src)创建 api-services 文件夹,并将 https://editor.swagger.io 生成的 typescript-axios 代码(.ts 后缀文件)放入其中(注意 package.json 文件中 axios 的版本,必须和项目保持一致,这里使用的是 v0.21.1 版本)。

  2. 拷贝 Furion 源码下的 clients/axios_vue_react/axios-utils.ts文件放置到 api-services 同级目录下,同时修改 serveConfig 中的配置地址为对应的服务器地址,同时安装 "axios": "^0.21.1" 的包到 package.json

  3. 基本使用

  • Promise 方式:
getAPI(SystemAPI)
  .apiGetXXXX()
  .then((res) => {
    var data = res.data.data!;
  })
  .catch((err) => {
    console.log(err);
  })
  .finally(() => {
    console.log("api request completed.");
  });
  • async/await 方式:
const [err, res] = await feature(getAPI(SystemAPI).apiGetXXX());

if (err) {
  console.log(err);
} else {
  var data = res.data.data!;
}

console.log("api request completed.");

如果服务器有 API 发生改变,重新生成代码并替换 api-services 目录所有代码即可(建议先删除里面所有文件后再粘贴

常见问题

Vue3 项目中启用 TypeScriptESlint 后报错,只需要修改相关的 tsconfig.json 文件添加以下配置即可:

"compilerOptions": {
    "importsNotUsedAsValues": "remove",
    "preserveValueImports": false
  }

Angular 项目中,可能会出现 override 错误问题,只需要编辑 api-services/base.ts 文件并添加 override 关键字即可,如:

推荐使用 Angular 版本

export class RequiredError extends Error {
  override name: "RequiredError" = "RequiredError";
}

Swagger 多分组处理

如果使用了Swagger 多分组的功能,可以升级 Furion 框架至 v3.3.4 版本,之后启用 EnableAllGroups 功能,如:

{
  "SpecificationDocumentSettings": {
    "EnableAllGroups": true
  }
}

这样就会自动将所有分组的内容合并到 All Groups 中。


打包:

  1. 初始化项目(文件夹名称一定不能有中文)

    npm init -y

    放入js、css、ts等静态文件。

  2. 查看当前源

    npm config get registry
    npm config set registry https://registry.npmjs.org --切换为npm源
    npm config set registry=https://registry.npm.taobao.org/ --切换到淘宝镜像
  3. 添加用户

    npm adduser
    ---中间是添加用户(应该会跳转到npmjs官网去验证邮箱登录等)
    npm who am i
  4. 上传自己的包

    npm version patch --自动将package.json中的version版本加0.0.1
    npm publish  --打包重新上传

    打包之前需要修改package.json中的版本号version!!!

    npm官网查看

更新web项目的js引用:

npm install
1.0.10

8 months ago

1.0.9

8 months ago

1.0.8

8 months ago

1.0.7

8 months ago

1.0.6

8 months ago

1.0.3

8 months ago

1.0.2

8 months ago

1.0.1

8 months ago

1.0.0

8 months ago