gen-api

npm install gen-api-ts

Add your script "gen: gen api YOUR SWAGGER URL" in package.json scripts

npm run gen -- qiye

1.pay attention to need exit routes/api and services in src

2.You must create a GEN at the outermost layer of the project the gateway and links(open F12 to find api-docs?group=*.0) using the GEN_API_CONFIG.js.js file

3.Define 'gen' in the scripts of package.json: 'gen api', use npm run gen to use this script

4.The script supports incremental updates and updates old TS interfaces by comparing them with each other (deprecated types need to be manually removed). You can also manually add your own interfaces to the file without worrying about being overwritten

5.use @self to keep change type. for example name: string; // @self else when types merge it will be replace

gitee url https://gitee.com/pan-xiaoquan/gen-api

1.注意需要存在 routes/api 文件夹 和 services 文件夹 在 src 文件夹下

2.你必须在项目的最外层创建一个 GEN_API_CONFIG.js 文件其中格式如下 来配置网关和 url 链接(打开f12找到api-docs?group=*.0这个接口将其链接作为url的地址)

const getUrlAndName = { 'qiye': { url: 'url', name: 'qiye' } } module.exports = { getUrlAndName }

3.在package.json的scripts中定义 "gen": "gen-api"，使用npm run gen 使用此脚本

4.脚本支持增量更新并通过相互比较来更新旧的ts接口(已弃用的类型需要手动删除),也可以手动在文件中添加自己的接口，不用担心会被覆盖

5.使用***@self**保留ts中自己更改的类型 例如 name: string; // @self 否则则在merge的时候会被替换

Made with ♥ by Pan Xiao Quan [email protected]