1.0.2 • Published 10 days ago

@yhclt/apifox-cli v1.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
10 days ago

apifox-cli

基于 APIFOX 平台,根据接口文档自动生成前端所需的api+ts的请求函数代码的小工具

How To Use

  1. 全局安装 apifox-cli:

    # 本地安装
    npm link
    
    npm i @yhclt/apifox-cli -g
    
    # 全局移除
    npm uninstall -g @yhclt/apifox-cli
    
    # 移除本地
    npm unlink -g @yhclt/apifox-cli
  2. 在项目根目录执行:apifox-cli init 生成 apifox.config.cjs 文件。文件内容如下:

    module.exports = {
      module: 'wx', // web | wx
      projectId: 0000000, // 访问https://app.apifox.com/main 查看你的项目id
      output: 'src/api', // 输出目录
      importHttp: `import { http } from '@/utils/http'`,
      // 如果Authorization过期,直接访问https://app.apifox.com/main从某个接口的请求头里面copy Authorization header放到这里就行
      Authorization: 'Bearer XXXXXX'
    }
  3. 在项目根目录执行命令:

    # 更新所有接口
    apifox-cli create --type=all
    
    # 按文件夹模块更新接口
    apifox-cli create --type=module
    
    # 按文件夹模块更新接口 --prefixPath参数可以给接口path增加统一的前缀
    apifox-cli create --type=module --prefixPath=testPrefix
    
    # 按api接口精确更新
    apifox-cli create --type=api
  4. 执行:apifox-cli help 查看帮助文档

  5. 在项目中配置 eslint 忽略文件:"ignorePatterns": [ "src/apis/**/*.ts" ], ignorePatterns 与 rules 一个级别的