smart-api-generator

smart-api-generator是一个高效能的工具，专门用来自动化创建API接口及其相关文档

功能点

• 以项目维度生成格式统一的接口配置，可直接用于生产环境中
• 良好的入参、出参注释，可直接拷贝使用接口调用代码
• 接口调用支持typescript智能提示与校验
• 支持ts文件生成与接口结构interface的生成

安装

// npm
npm install smart-api-generator -D

// yarn
yarn add smart-api-generator -D

// pnpm
pnpm install smart-api-generator -D

使用步骤

1、在 package.json 中配置命令，配置文件可指定路径，如果不指定路径默认取根目录下的.api.config.js文件

"scripts": {
        ......
    "api": "cross-env smart-api create --config /path/to/.api.config.js"
},

2、在工程中添加配置文件·api.config.js

module.exports = {
    output: './src/request',
    projects: [
        {
            projectName: 'xxx',
            basePath: 'xxx',
            //...
        }
    ]
}

3、在根目录中运行命令

npm run api

配置项

projects