@sjzy/generate-api
TypeScript icon, indicating that this package has built-in type declarations

1.0.24 • Public • Published

@sjzy/generate-api

此插件可以从rap2中,自动爬取接口信息,并生成对应接口方法,以及类型声明文件

安装依赖

pnpm add @sjzy/generate-api -D

立即开始

1、在项目根目录创建api.config.js 配置文件,参考:

/*
初始化编译配置
export interface DefaultAppConfig {
  /* 字符串或者数组,值是rap2对应的请求接口Json数据;*/
  api: string | string[]
  /* 生成api接口文件的存放地址,值为一个相对路径 */
  apiFileUrl: string
  /* 生成api类型声明文件的存放地址,值为一个相对路径 */
  interfaceFileUrl: string
  /* 声明文件命名空间 */
  namespaceName: string
  /* 引入自己封装的请求实例地址 例如 '@/request/axios.js' 此路径应该是在生成api文件后在该文件夹内能访问到请求实例的有效路径; */
  requestInstance: string
}
 */
module.exports = {
  apiFileUrl: './src/apis/index.ts',
  interfaceFileUrl: './src/apis/api.d.ts',
  namespaceName: 'Api',
  api: 'http://192.168.10.2:38080/repository/get?id=27&token=AUlVyXM4XlJO9wPE0OI24XrKgsfPJV42',
  requestInstance: `import request from '@/hooks/useRequest.js'\nimport { extraConf } from '@/utils/http/types'`,
}

2、建完api.config.js文件后,在package.json中新建命令

"scripts": {
    "api": "api"
}

3、然后运行命令即可

npm run api

4、当然,如果不想修改package.json,直接运行npx命令也可以~

npx api

Readme

Keywords

none

Package Sidebar

Install

npm i @sjzy/generate-api

Weekly Downloads

0

Version

1.0.24

License

ISC

Unpacked Size

32.1 kB

Total Files

22

Last publish

Collaborators

  • youngkai