@fxri/swagger2api 1.0.15 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -10,16 +10,66 @@
10
10
  - ⚙️ **环境依赖** - 工具需要在 node@20 及以上运行时环境下使用
11
11
  - 🔧 **CLI 工具** - 更多参数可查看 swagger-typescript-api 官方文档
12
12
 
13
+ ## 💡 功能简介
14
+
15
+ ### 快速模式
16
+
17
+ 快速模式,直接使用配置文件参数,若配置文件不存在或者参数不全,则不会进入该模式
18
+
19
+ ### 指定配置
20
+
21
+ 指定配置文件路径,支持多选,用【,】分隔,使用该配置后则不会触发配置扫描功能
22
+
23
+ ### 多文档配置
24
+
25
+ 默认配置文档为saconfig.json,项目启动后会扫描当前项目下的所有符合【./**/saconfig*.json】规则的文件(如【saconfig.json】【saconfig.admin.json】【config/saconfig.json】等),并在扫描到多个文件是提供选择列表,如只有一个文件,则直接进入下一步,该功能可在配置项中关闭
26
+
13
27
  ## 📦 安装
14
28
 
29
+ pnpm
30
+
15
31
  ```bash
16
32
  # 全局安装
17
33
  pnpm install -g @fxri/swagger2api
34
+ ```
18
35
 
36
+ ```bash
19
37
  # 项目依赖
20
38
  pnpm install @fxri/swagger2api
21
39
  ```
22
40
 
41
+ yarn
42
+
43
+ ```bash
44
+ # 全局安装
45
+ yarn global add @fxri/swagger2api
46
+ ```
47
+
48
+ ```bash
49
+ # 项目依赖
50
+ yarn add @fxri/swagger2api
51
+ ```
52
+
53
+ ## 📝 PNPM 脚本
54
+
55
+ 在 `package.json` 中添加:
56
+
57
+ 生成 axios http 客户端,生成有关请求响应的附加信息,移除第一个前缀索引,使用快速模式
58
+
59
+ ```json
60
+ {
61
+ "scripts": {
62
+ "api": "swagger2api --axios --responses --remove-prefix-index 0 --quick"
63
+ }
64
+ }
65
+
66
+ {
67
+ "scripts": {
68
+ "api": "npx @fxri/swagger2api --axios --responses --remove-prefix-index 0 --quick"
69
+ }
70
+ }
71
+ ```
72
+
23
73
  ## 🚀 快速开始
24
74
 
25
75
  ### 1. 生成接口代码
@@ -66,19 +116,29 @@ api.getUsers().then((res) => console.log(res))
66
116
  | `url` | string | - | Swagger JSON 文件路径或 URL |
67
117
  | `output` | string | `'./src/api'` | 生成代码的输出目录 |
68
118
  | `name` | string | `'index'` | 接口文件名称,默认后缀为ts |
69
- | `--config,-c` | string | `'.swaggerrc'` | 配置文件 |
70
- | `--quick,-q` | boolean | `false` | 快速模式,直接使用配置文件参数,若配置文件不存在或者参数不全,则不会进入该模式 |
119
+ | `--quick,-q` | boolean | `false` | 快速模式,直接使用配置文件参数,不再二次确认参数 |
120
+ | `--config,-c` | string | `'saconfig.json'` | 填写配置文件路径,支持多选,用【,】分隔,使用该配置后则不会触发配置扫描功能 |
121
+ | `--config-all,-ca` | boolean | `false` | 加载全部配置文件,不进行选择 |
122
+ | `--config-scan,-cs` | boolean | `true` | 扫描全部配置文件,并提供选择列表 |
71
123
  | `--convert-get,-cg` | boolean | `false` | 转换无{.+}get为query |
72
124
  | `--remove-param,-rp` | boolean | `false` | 移除{.+}参数 |
73
125
  | `--remove-prefix-index,-rpi` | number | `-1` | 移除前缀索引 |
74
- | `--remove-d.ts,-rd` | boolean | `false` | 移除使用--js参数时生成的d.ts文件 |
126
+ | `--remove-dts,-rd` | boolean | `false` | 移除使用--js参数时生成的d.ts文件 |
75
127
 
76
128
  扩展:[更多 swagger-typescript-api 配置选项](https://fig.io/manual/swagger-typescript-api)
77
129
 
78
130
  ## 🔧 CLI 命令
79
131
 
80
132
  ```bash
81
- # 自定义配置文件
133
+ # 快速模式,直接使用配置文件参数,不再二次确认参数
134
+
135
+ npx swagger2api [--quick,-q] [--quick,-q <boolean>]
136
+
137
+ npx @fxri/swagger2api [--quick,-q] [--quick,-q <boolean>]
138
+ ```
139
+
140
+ ```bash
141
+ # 填写配置文件路径,支持多选,用【,】分隔,使用该配置后则不会触发配置扫描功能
82
142
 
83
143
  npx swagger2api [--config,-c <path>]
84
144
 
@@ -86,11 +146,19 @@ npx @fxri/swagger2api [--config,-c <path>]
86
146
  ```
87
147
 
88
148
  ```bash
89
- # 快速模式,直接使用配置文件参数,若配置文件不存在或者参数不全,则不会进入该模式
149
+ # 加载全部配置文件,不进行选择
90
150
 
91
- npx swagger2api [--quick,-q] [--quick,-q <boolean>]
151
+ npx swagger2api [--config-all,-ca] [--config-all,-ca <boolean>]
92
152
 
93
- npx @fxri/swagger2api [--quick,-q] [--quick,-q <boolean>]
153
+ npx @fxri/swagger2api [--config-all,-ca] [--config-all,-ca <boolean>]
154
+ ```
155
+
156
+ ```bash
157
+ # 扫描全部配置文件,并提供选择列表,该参数默认为true
158
+
159
+ npx swagger2api [--config-scan,-cs] [--config-scan,-cs <boolean>]
160
+
161
+ npx @fxri/swagger2api [--config-scan,-cs] [--config-scan,-cs <boolean>]
94
162
  ```
95
163
 
96
164
  ```bash
@@ -120,29 +188,9 @@ npx @fxri/swagger2api [--remove-prefix-index,-rpi <number>]
120
188
  ```bash
121
189
  # 移除使用--js参数时生成的d.ts文件
122
190
 
123
- npx swagger2api [--remove-d.ts,-rd] [--remove-d.ts,-rd <boolean>]
124
-
125
- npx @fxri/swagger2api [--remove-d.ts,-rd] [--remove-d.ts,-rd <boolean>]
126
- ```
127
-
128
- ## 📝 PNPM 脚本
129
-
130
- 在 `package.json` 中添加:
131
-
132
- 生成 axios http 客户端,生成有关请求响应的附加信息,移除第一个前缀索引,使用快速模式
133
-
134
- ```json
135
- {
136
- "scripts": {
137
- "api": "swagger2api --axios --responses --remove-prefix-index 0 --quick"
138
- }
139
- }
191
+ npx swagger2api [--remove-dts,-rd] [--remove-dts,-rd <boolean>]
140
192
 
141
- {
142
- "scripts": {
143
- "api": "npx @fxri/swagger2api --axios --responses --remove-prefix-index 0 --quick"
144
- }
145
- }
193
+ npx @fxri/swagger2api [--remove-dts,-rd] [--remove-dts,-rd <boolean>]
146
194
  ```
147
195
 
148
196
  ## 🤝 贡献
@@ -0,0 +1 @@
1
+ var A=Object.create;var x=Object.defineProperty;var P=Object.getOwnPropertyDescriptor;var E=Object.getOwnPropertyNames;var T=Object.getPrototypeOf,q=Object.prototype.hasOwnProperty;var D=(e,r,n,s)=>{if(r&&typeof r=="object"||typeof r=="function")for(let i of E(r))!q.call(e,i)&&i!==n&&x(e,i,{get:()=>r[i],enumerable:!(s=P(r,i))||s.enumerable});return e};var m=(e,r,n)=>(n=e!=null?A(T(e)):{},D(r||!e||!e.__esModule?x(n,"default",{value:e,enumerable:!0}):n,e));var j=m(require("axios"),1),O=require("child_process"),F=m(require("os"),1),g=m(require("fs"),1),c=m(require("path"),1),h=m(require("prompts"),1),N=require("swagger-typescript-api");var b=e=>/^(https?:\/\/|:?\/\/)/.test(e);var f=m(require("fs"),1),v=m(require("path"),1),u={param:process.argv.filter((e,r)=>r>1),used:{}};function w(e,r=!0,n=!0){Array.isArray(e)||(e=[e]);let s;return u.param.forEach((i,p)=>{if(e.includes(i))r?(s=u.param[p+1],n&&Object.assign(u.used,{[p+1]:!0})):["true","false"].includes(u.param[p+1])?(s=u.param[p+1].toLowerCase()=="true",n&&Object.assign(u.used,{[p+1]:!0})):s=!0;else return;n&&Object.assign(u.used,{[p]:!0})}),s}function a(e,r=!0){return w(e,!1,r)}function o(e,r=!0){return w(e,!0,r)}function d(e,r){let n=v.default.dirname(e);f.default.existsSync(n)||f.default.mkdirSync(n,{recursive:!0}),f.default.writeFileSync(e,r)}var $=require("glob"),t={files:[],param:{}},l={home:F.default.homedir(),enum:{}};function y(e){e&&console.log(e),process.exit()}async function C(){o(["--config","-c"])?t.files=o(["--config","-c"]).split(","):a(["--config-scan","-cs"])&&(t.files=$.glob.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),t.files.length==0&&(t.files=["saconfig.json"]),!a(["--config-all","-ca"])&&t.files.length>1&&(t.files=(await(0,h.default)({type:"multiselect",name:"files",message:"\u9009\u62E9\u914D\u7F6E\u6587\u4EF6",hint:"\u53EF\u591A\u9009\uFF0C\u7A7A\u683C\u952E\u52FE\u9009\uFF0C\u56DE\u8F66\u5B8C\u6210",choices:t.files.map(e=>({title:e.replace(/\\/g,"/"),value:e}))}).then(e=>e.files?.length!=0?e:y("\u7ED3\u675F\uFF1A\u81F3\u5C11\u9009\u62E9\u4E00\u4E2A\u914D\u7F6E\u6587\u4EF6"))).files),t.files?.length>0||y("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA")}async function J(){try{t.param=JSON.parse(g.default.readFileSync(t.file,"utf-8"))}catch{}(!a(["--quick","-q"])||[t.param.url,t.param.output,t.param.name].includes(void 0))&&(t.param=await(0,h.default)([{name:"url",type:"text",message:"Swagger docs \u5730\u5740:",initial:t.param.url??"https://example.com/v3/api-docs"},{name:"output",type:"text",message:"\u8F93\u51FA\u5730\u5740:",initial:t.param.output??"./src/api"},{name:"name",type:"text",message:"\u6587\u4EF6\u540D:",initial:t.param.name??"index"}])),[t.param.url,t.param.output,t.param.name].includes(void 0)&&y("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA"),l.docFile=c.default.resolve(`${t.param.output}/${t.param.name}-${new Date().getTime()}.json`)}async function k(e=0){if(t.file=t.files[e],await J(),b(t.param.url))await j.default.get(t.param.url).then(r=>S(r.data)).catch(r=>console.log("\u5931\u8D25\uFF1A",r));else try{await S(JSON.parse(g.default.readFileSync(c.default.resolve(t.param.url),"utf8")))}catch(r){console.log("\u5931\u8D25\uFF1A",r)}t.files[e+1]&&k(e+1)}async function S(e){if(typeof e?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(e.paths).forEach(r=>{Object.keys(r[1]).forEach(n=>{let s=`${r[0]}/${n}`;if(a(["--convert-get","-cg"])&&(s=s.replace(/([^\}]\/)get$/g,"$1query")),a(["--remove-param","-rp"])&&(s=s.replace(/\/\{.+?\}/g,"")),o(["--remove-prefix-index","-rpi"])){let p=s.split("/");p=p.slice(0,1).concat(p.slice(Number(o(["--remove-prefix-index","-rpi"]))+2)),s=p.join("/")}e.paths[r[0]][n].operationId=s;let i=s.split("/").slice(-1)[0];typeof l.enum[i]=="number"?l.enum[i]++:l.enum[i]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(l.enum).map(r=>r.join("-"))),d(l.docFile,JSON.stringify(e)),console.log("\u6267\u884C\uFF1A",t.file),await(0,N.generateApi)({fileName:`${t.param.name}.ts`,output:c.default.resolve(t.param.output),input:l.docFile,templates:o(["--templates","-t"]),defaultResponseAsSuccess:a(["--default-as-success","-d"]),generateResponses:a(["--responses","-r"]),generateUnionEnums:a("--union-enums"),addReadonly:a("--add-readonly"),generateRouteTypes:a("--route-types"),generateClient:!a("--no-client"),enumNamesAsValues:a("--enum-names-as-values"),extractRequestParams:a("--extract-request-params"),extractRequestBody:a("--extract-request-body"),extractResponseBody:a("--extract-response-body"),extractResponseError:a("--extract-response-error"),modular:a("--modular"),toJS:a("--js"),moduleNameIndex:Number(o("--module-name-index")??0),moduleNameFirstTag:a("--module-name-first-tag"),httpClientType:a("--axios")?"axios":"fetch",unwrapResponseData:a("--unwrap-response-data"),disableThrowOnError:a("--disable-throw-on-error"),singleHttpClient:a("--single-http-client"),silent:a("--silent"),defaultResponseType:o("--default-response")??"void",typePrefix:o("--type-prefix")??"",typeSuffix:o("--type-suffix")??"",cleanOutput:a("--clean-output"),...o("--api-class-name")?{apiClassName:o("--api-class-name")}:{},patch:a("--patch"),debug:a("--debug"),anotherArrayType:a("--another-array-type"),sortTypes:a("--sort-types"),extractEnums:a("--extract-enums")}),g.default.unlinkSync(l.docFile),a(["--remove-dts","-rd"])&&(console.log("\u6E05\u7406\uFF1A",c.default.resolve(t.param.output,`${t.param.name}.d.ts`)),(0,O.execSync)(`npx rimraf ${c.default.resolve(t.param.output,`${t.param.name}.d.ts`)}`,{cwd:l.home}).toString()),d(t.file,JSON.stringify(t.param,null,2))}async function R(){await C(),k()}R();
@@ -0,0 +1,2 @@
1
+
2
+ export { }
@@ -0,0 +1,2 @@
1
+
2
+ export { }
@@ -0,0 +1 @@
1
+ import j from"axios";import{execSync as O}from"child_process";import F from"os";import d from"fs";import u from"path";import b from"prompts";import{generateApi as N}from"swagger-typescript-api";var y=t=>/^(https?:\/\/|:?\/\/)/.test(t);import c from"fs";import S from"path";var l={param:process.argv.filter((t,r)=>r>1),used:{}};function h(t,r=!0,i=!0){Array.isArray(t)||(t=[t]);let s;return l.param.forEach((m,o)=>{if(t.includes(m))r?(s=l.param[o+1],i&&Object.assign(l.used,{[o+1]:!0})):["true","false"].includes(l.param[o+1])?(s=l.param[o+1].toLowerCase()=="true",i&&Object.assign(l.used,{[o+1]:!0})):s=!0;else return;i&&Object.assign(l.used,{[o]:!0})}),s}function a(t,r=!0){return h(t,!1,r)}function n(t,r=!0){return h(t,!0,r)}function f(t,r){let i=S.dirname(t);c.existsSync(i)||c.mkdirSync(i,{recursive:!0}),c.writeFileSync(t,r)}import{glob as $}from"glob";var e={files:[],param:{}},p={home:F.homedir(),enum:{}};function g(t){t&&console.log(t),process.exit()}async function k(){n(["--config","-c"])?e.files=n(["--config","-c"]).split(","):a(["--config-scan","-cs"])&&(e.files=$.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),e.files.length==0&&(e.files=["saconfig.json"]),!a(["--config-all","-ca"])&&e.files.length>1&&(e.files=(await b({type:"multiselect",name:"files",message:"\u9009\u62E9\u914D\u7F6E\u6587\u4EF6",hint:"\u53EF\u591A\u9009\uFF0C\u7A7A\u683C\u952E\u52FE\u9009\uFF0C\u56DE\u8F66\u5B8C\u6210",choices:e.files.map(t=>({title:t.replace(/\\/g,"/"),value:t}))}).then(t=>t.files?.length!=0?t:g("\u7ED3\u675F\uFF1A\u81F3\u5C11\u9009\u62E9\u4E00\u4E2A\u914D\u7F6E\u6587\u4EF6"))).files),e.files?.length>0||g("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA")}async function R(){try{e.param=JSON.parse(d.readFileSync(e.file,"utf-8"))}catch{}(!a(["--quick","-q"])||[e.param.url,e.param.output,e.param.name].includes(void 0))&&(e.param=await b([{name:"url",type:"text",message:"Swagger docs \u5730\u5740:",initial:e.param.url??"https://example.com/v3/api-docs"},{name:"output",type:"text",message:"\u8F93\u51FA\u5730\u5740:",initial:e.param.output??"./src/api"},{name:"name",type:"text",message:"\u6587\u4EF6\u540D:",initial:e.param.name??"index"}])),[e.param.url,e.param.output,e.param.name].includes(void 0)&&g("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA"),p.docFile=u.resolve(`${e.param.output}/${e.param.name}-${new Date().getTime()}.json`)}async function v(t=0){if(e.file=e.files[t],await R(),y(e.param.url))await j.get(e.param.url).then(r=>x(r.data)).catch(r=>console.log("\u5931\u8D25\uFF1A",r));else try{await x(JSON.parse(d.readFileSync(u.resolve(e.param.url),"utf8")))}catch(r){console.log("\u5931\u8D25\uFF1A",r)}e.files[t+1]&&v(t+1)}async function x(t){if(typeof t?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(t.paths).forEach(r=>{Object.keys(r[1]).forEach(i=>{let s=`${r[0]}/${i}`;if(a(["--convert-get","-cg"])&&(s=s.replace(/([^\}]\/)get$/g,"$1query")),a(["--remove-param","-rp"])&&(s=s.replace(/\/\{.+?\}/g,"")),n(["--remove-prefix-index","-rpi"])){let o=s.split("/");o=o.slice(0,1).concat(o.slice(Number(n(["--remove-prefix-index","-rpi"]))+2)),s=o.join("/")}t.paths[r[0]][i].operationId=s;let m=s.split("/").slice(-1)[0];typeof p.enum[m]=="number"?p.enum[m]++:p.enum[m]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(p.enum).map(r=>r.join("-"))),f(p.docFile,JSON.stringify(t)),console.log("\u6267\u884C\uFF1A",e.file),await N({fileName:`${e.param.name}.ts`,output:u.resolve(e.param.output),input:p.docFile,templates:n(["--templates","-t"]),defaultResponseAsSuccess:a(["--default-as-success","-d"]),generateResponses:a(["--responses","-r"]),generateUnionEnums:a("--union-enums"),addReadonly:a("--add-readonly"),generateRouteTypes:a("--route-types"),generateClient:!a("--no-client"),enumNamesAsValues:a("--enum-names-as-values"),extractRequestParams:a("--extract-request-params"),extractRequestBody:a("--extract-request-body"),extractResponseBody:a("--extract-response-body"),extractResponseError:a("--extract-response-error"),modular:a("--modular"),toJS:a("--js"),moduleNameIndex:Number(n("--module-name-index")??0),moduleNameFirstTag:a("--module-name-first-tag"),httpClientType:a("--axios")?"axios":"fetch",unwrapResponseData:a("--unwrap-response-data"),disableThrowOnError:a("--disable-throw-on-error"),singleHttpClient:a("--single-http-client"),silent:a("--silent"),defaultResponseType:n("--default-response")??"void",typePrefix:n("--type-prefix")??"",typeSuffix:n("--type-suffix")??"",cleanOutput:a("--clean-output"),...n("--api-class-name")?{apiClassName:n("--api-class-name")}:{},patch:a("--patch"),debug:a("--debug"),anotherArrayType:a("--another-array-type"),sortTypes:a("--sort-types"),extractEnums:a("--extract-enums")}),d.unlinkSync(p.docFile),a(["--remove-dts","-rd"])&&(console.log("\u6E05\u7406\uFF1A",u.resolve(e.param.output,`${e.param.name}.d.ts`)),O(`npx rimraf ${u.resolve(e.param.output,`${e.param.name}.d.ts`)}`,{cwd:p.home}).toString()),f(e.file,JSON.stringify(e.param,null,2))}async function w(){await k(),v()}w();
package/dist/index.cjs ADDED
@@ -0,0 +1 @@
1
+ var P=Object.create;var f=Object.defineProperty;var A=Object.getOwnPropertyDescriptor;var E=Object.getOwnPropertyNames;var T=Object.getPrototypeOf,q=Object.prototype.hasOwnProperty;var D=(e,a)=>{for(var s in a)f(e,s,{get:a[s],enumerable:!0})},b=(e,a,s,n)=>{if(a&&typeof a=="object"||typeof a=="function")for(let i of E(a))!q.call(e,i)&&i!==s&&f(e,i,{get:()=>a[i],enumerable:!(n=A(a,i))||n.enumerable});return e};var m=(e,a,s)=>(s=e!=null?P(T(e)):{},b(a||!e||!e.__esModule?f(s,"default",{value:e,enumerable:!0}):s,e)),C=e=>b(f({},"__esModule",{value:!0}),e);var U={};D(U,{generateApi:()=>I});module.exports=C(U);var O=m(require("axios"),1),F=require("child_process"),N=m(require("os"),1),d=m(require("fs"),1),c=m(require("path"),1),x=m(require("prompts"),1),$=require("swagger-typescript-api");var v=e=>/^(https?:\/\/|:?\/\/)/.test(e);var g=m(require("fs"),1),w=m(require("path"),1),u={param:process.argv.filter((e,a)=>a>1),used:{}};function S(e,a=!0,s=!0){Array.isArray(e)||(e=[e]);let n;return u.param.forEach((i,p)=>{if(e.includes(i))a?(n=u.param[p+1],s&&Object.assign(u.used,{[p+1]:!0})):["true","false"].includes(u.param[p+1])?(n=u.param[p+1].toLowerCase()=="true",s&&Object.assign(u.used,{[p+1]:!0})):n=!0;else return;s&&Object.assign(u.used,{[p]:!0})}),n}function r(e,a=!0){return S(e,!1,a)}function o(e,a=!0){return S(e,!0,a)}function y(e,a){let s=w.default.dirname(e);g.default.existsSync(s)||g.default.mkdirSync(s,{recursive:!0}),g.default.writeFileSync(e,a)}var k=require("glob"),t={files:[],param:{}},l={home:N.default.homedir(),enum:{}};function h(e){e&&console.log(e),process.exit()}async function J(){o(["--config","-c"])?t.files=o(["--config","-c"]).split(","):r(["--config-scan","-cs"])&&(t.files=k.glob.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),t.files.length==0&&(t.files=["saconfig.json"]),!r(["--config-all","-ca"])&&t.files.length>1&&(t.files=(await(0,x.default)({type:"multiselect",name:"files",message:"\u9009\u62E9\u914D\u7F6E\u6587\u4EF6",hint:"\u53EF\u591A\u9009\uFF0C\u7A7A\u683C\u952E\u52FE\u9009\uFF0C\u56DE\u8F66\u5B8C\u6210",choices:t.files.map(e=>({title:e.replace(/\\/g,"/"),value:e}))}).then(e=>e.files?.length!=0?e:h("\u7ED3\u675F\uFF1A\u81F3\u5C11\u9009\u62E9\u4E00\u4E2A\u914D\u7F6E\u6587\u4EF6"))).files),t.files?.length>0||h("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA")}async function L(){try{t.param=JSON.parse(d.default.readFileSync(t.file,"utf-8"))}catch{}(!r(["--quick","-q"])||[t.param.url,t.param.output,t.param.name].includes(void 0))&&(t.param=await(0,x.default)([{name:"url",type:"text",message:"Swagger docs \u5730\u5740:",initial:t.param.url??"https://example.com/v3/api-docs"},{name:"output",type:"text",message:"\u8F93\u51FA\u5730\u5740:",initial:t.param.output??"./src/api"},{name:"name",type:"text",message:"\u6587\u4EF6\u540D:",initial:t.param.name??"index"}])),[t.param.url,t.param.output,t.param.name].includes(void 0)&&h("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA"),l.docFile=c.default.resolve(`${t.param.output}/${t.param.name}-${new Date().getTime()}.json`)}async function R(e=0){if(t.file=t.files[e],await L(),v(t.param.url))await O.default.get(t.param.url).then(a=>j(a.data)).catch(a=>console.log("\u5931\u8D25\uFF1A",a));else try{await j(JSON.parse(d.default.readFileSync(c.default.resolve(t.param.url),"utf8")))}catch(a){console.log("\u5931\u8D25\uFF1A",a)}t.files[e+1]&&R(e+1)}async function j(e){if(typeof e?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(e.paths).forEach(a=>{Object.keys(a[1]).forEach(s=>{let n=`${a[0]}/${s}`;if(r(["--convert-get","-cg"])&&(n=n.replace(/([^\}]\/)get$/g,"$1query")),r(["--remove-param","-rp"])&&(n=n.replace(/\/\{.+?\}/g,"")),o(["--remove-prefix-index","-rpi"])){let p=n.split("/");p=p.slice(0,1).concat(p.slice(Number(o(["--remove-prefix-index","-rpi"]))+2)),n=p.join("/")}e.paths[a[0]][s].operationId=n;let i=n.split("/").slice(-1)[0];typeof l.enum[i]=="number"?l.enum[i]++:l.enum[i]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(l.enum).map(a=>a.join("-"))),y(l.docFile,JSON.stringify(e)),console.log("\u6267\u884C\uFF1A",t.file),await(0,$.generateApi)({fileName:`${t.param.name}.ts`,output:c.default.resolve(t.param.output),input:l.docFile,templates:o(["--templates","-t"]),defaultResponseAsSuccess:r(["--default-as-success","-d"]),generateResponses:r(["--responses","-r"]),generateUnionEnums:r("--union-enums"),addReadonly:r("--add-readonly"),generateRouteTypes:r("--route-types"),generateClient:!r("--no-client"),enumNamesAsValues:r("--enum-names-as-values"),extractRequestParams:r("--extract-request-params"),extractRequestBody:r("--extract-request-body"),extractResponseBody:r("--extract-response-body"),extractResponseError:r("--extract-response-error"),modular:r("--modular"),toJS:r("--js"),moduleNameIndex:Number(o("--module-name-index")??0),moduleNameFirstTag:r("--module-name-first-tag"),httpClientType:r("--axios")?"axios":"fetch",unwrapResponseData:r("--unwrap-response-data"),disableThrowOnError:r("--disable-throw-on-error"),singleHttpClient:r("--single-http-client"),silent:r("--silent"),defaultResponseType:o("--default-response")??"void",typePrefix:o("--type-prefix")??"",typeSuffix:o("--type-suffix")??"",cleanOutput:r("--clean-output"),...o("--api-class-name")?{apiClassName:o("--api-class-name")}:{},patch:r("--patch"),debug:r("--debug"),anotherArrayType:r("--another-array-type"),sortTypes:r("--sort-types"),extractEnums:r("--extract-enums")}),d.default.unlinkSync(l.docFile),r(["--remove-dts","-rd"])&&(console.log("\u6E05\u7406\uFF1A",c.default.resolve(t.param.output,`${t.param.name}.d.ts`)),(0,F.execSync)(`npx rimraf ${c.default.resolve(t.param.output,`${t.param.name}.d.ts`)}`,{cwd:l.home}).toString()),y(t.file,JSON.stringify(t.param,null,2))}async function I(){await J(),R()}0&&(module.exports={generateApi});
@@ -0,0 +1,4 @@
1
+ /** 主线 */
2
+ declare function onMain(): Promise<void>;
3
+
4
+ export { onMain as generateApi };
package/dist/index.d.ts CHANGED
@@ -1 +1,4 @@
1
- export {};
1
+ /** 主线 */
2
+ declare function onMain(): Promise<void>;
3
+
4
+ export { onMain as generateApi };
package/dist/index.js CHANGED
@@ -1,115 +1 @@
1
- import axios from "axios";
2
- import { execSync } from "node:child_process";
3
- import os from "node:os";
4
- import fs from "node:fs";
5
- import url from "node:url";
6
- import path from "node:path";
7
- import prompts from "prompts";
8
- import { getParam, getParamList, isUrl, saveFile } from "./utils/index.js";
9
- /** 配置集合 */
10
- const confs = {
11
- /** 文件 */
12
- file: path.resolve(getParam(["--config", "-c"]) ?? ".swaggerrc"),
13
- /** 参数 */
14
- param: {}
15
- };
16
- try {
17
- confs.param = JSON.parse(fs.readFileSync(confs.file, "utf-8"));
18
- }
19
- catch (error) { }
20
- // 检查快速模式
21
- if (!getParam(["--quick", "-q"], false) || [confs.param.url, confs.param.output, confs.param.name].includes(undefined)) {
22
- // 输入配置
23
- confs.param = await prompts([
24
- { name: "url", type: "text", message: "Swagger docs 地址:", initial: confs.param.url ?? "https://example.com/v3/api-docs" },
25
- { name: "output", type: "text", message: "输出地址:", initial: confs.param.output ?? "./src/api" },
26
- { name: "name", type: "text", message: "文件名:", initial: confs.param.name ?? "index" }
27
- ]);
28
- }
29
- // 检查配置
30
- if ([confs.param.url, confs.param.output, confs.param.name].includes(undefined)) {
31
- console.log("失败:手动退出");
32
- process.exit();
33
- }
34
- /** 数据集合 */
35
- const datas = {
36
- /** 用户目录 */
37
- home: os.homedir(),
38
- /** 脚本 */
39
- script: path.resolve(path.dirname(url.fileURLToPath(import.meta.url)), "../node_modules/.bin/swagger-typescript-api"),
40
- /** 文件 */
41
- file: path.resolve(`${confs.param.output}/${confs.param.name}-${new Date().getTime()}.json`),
42
- /** 枚举 */
43
- enum: {}
44
- };
45
- /** 生成 */
46
- function onGenerate(data) {
47
- // 检查格式
48
- if (typeof data?.paths != "object")
49
- return console.log("失败:缺少paths字段");
50
- // 处理数据
51
- Object.entries(data.paths).forEach((item) => {
52
- Object.keys(item[1]).forEach((item2) => {
53
- // 配置操作id
54
- let id = `${item[0]}/${item2}`;
55
- // 转换无{.+}get为query
56
- if (getParam(["--convert-get", "-cg"], false)) {
57
- id = id.replace(/([^\}]\/)get$/g, "$1query");
58
- }
59
- // 移除参数
60
- if (getParam(["--remove-param", "-rp"], false)) {
61
- id = id.replace(/\/\{.+?\}/g, "");
62
- }
63
- // 移除前缀索引
64
- if (getParam(["--remove-prefix-index", "-rpi"])) {
65
- let ids = id.split("/");
66
- ids = ids.slice(0, 1).concat(ids.slice(Number(getParam(["--remove-prefix-index", "-rpi"])) + 2));
67
- id = ids.join("/");
68
- }
69
- // 配置操作id
70
- data.paths[item[0]][item2].operationId = id;
71
- // 统计请求方式
72
- const method = id.split("/").slice(-1)[0];
73
- typeof datas.enum[method] == "number" ? datas.enum[method]++ : (datas.enum[method] = 1);
74
- });
75
- });
76
- console.log("就绪:", ...Object.entries(datas.enum).map((item) => item.join("-")));
77
- // 保存文档
78
- saveFile(datas.file, JSON.stringify(data));
79
- // 获取移除文件参数
80
- const rd = getParam(["--remove-d.ts", "-rd"], false);
81
- // 生成接口
82
- const param = ["generate", "-n", `${confs.param.name}.ts`, "-o", path.resolve(confs.param.output), "-p", datas.file, ...getParamList(false)];
83
- console.log("执行:", execSync(`${datas.script} ${param.join(" ")}`, { cwd: datas.home }).toString());
84
- // 删除文档
85
- fs.unlinkSync(datas.file);
86
- // 移除使用--js参数时生成的d.ts文件
87
- if (rd) {
88
- console.log("移除:", path.resolve(confs.param.output, `${confs.param.name}.d.ts`));
89
- execSync(`npx rimraf ${path.resolve(confs.param.output, `${confs.param.name}.d.ts`)}`, { cwd: datas.home }).toString();
90
- }
91
- // 保存配置
92
- saveFile(confs.file, JSON.stringify(confs.param, null, 4));
93
- }
94
- /** 运行 */
95
- function onRun(url = confs.param.url) {
96
- // 检查地址
97
- if (isUrl(url)) {
98
- // 请求文档
99
- axios
100
- .get(url)
101
- .then((res) => onGenerate(res.data))
102
- .catch((err) => console.log("失败:", err));
103
- }
104
- else {
105
- try {
106
- // 读取文档
107
- onGenerate(JSON.parse(fs.readFileSync(path.resolve(url), "utf8")));
108
- }
109
- catch (error) {
110
- console.log("失败:", error);
111
- }
112
- }
113
- }
114
- // 执行脚本
115
- onRun();
1
+ import S from"axios";import{execSync as j}from"child_process";import O from"os";import d from"fs";import u from"path";import b from"prompts";import{generateApi as F}from"swagger-typescript-api";var y=t=>/^(https?:\/\/|:?\/\/)/.test(t);import c from"fs";import w from"path";var l={param:process.argv.filter((t,r)=>r>1),used:{}};function h(t,r=!0,i=!0){Array.isArray(t)||(t=[t]);let s;return l.param.forEach((m,o)=>{if(t.includes(m))r?(s=l.param[o+1],i&&Object.assign(l.used,{[o+1]:!0})):["true","false"].includes(l.param[o+1])?(s=l.param[o+1].toLowerCase()=="true",i&&Object.assign(l.used,{[o+1]:!0})):s=!0;else return;i&&Object.assign(l.used,{[o]:!0})}),s}function a(t,r=!0){return h(t,!1,r)}function n(t,r=!0){return h(t,!0,r)}function f(t,r){let i=w.dirname(t);c.existsSync(i)||c.mkdirSync(i,{recursive:!0}),c.writeFileSync(t,r)}import{glob as N}from"glob";var e={files:[],param:{}},p={home:O.homedir(),enum:{}};function g(t){t&&console.log(t),process.exit()}async function $(){n(["--config","-c"])?e.files=n(["--config","-c"]).split(","):a(["--config-scan","-cs"])&&(e.files=N.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),e.files.length==0&&(e.files=["saconfig.json"]),!a(["--config-all","-ca"])&&e.files.length>1&&(e.files=(await b({type:"multiselect",name:"files",message:"\u9009\u62E9\u914D\u7F6E\u6587\u4EF6",hint:"\u53EF\u591A\u9009\uFF0C\u7A7A\u683C\u952E\u52FE\u9009\uFF0C\u56DE\u8F66\u5B8C\u6210",choices:e.files.map(t=>({title:t.replace(/\\/g,"/"),value:t}))}).then(t=>t.files?.length!=0?t:g("\u7ED3\u675F\uFF1A\u81F3\u5C11\u9009\u62E9\u4E00\u4E2A\u914D\u7F6E\u6587\u4EF6"))).files),e.files?.length>0||g("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA")}async function k(){try{e.param=JSON.parse(d.readFileSync(e.file,"utf-8"))}catch{}(!a(["--quick","-q"])||[e.param.url,e.param.output,e.param.name].includes(void 0))&&(e.param=await b([{name:"url",type:"text",message:"Swagger docs \u5730\u5740:",initial:e.param.url??"https://example.com/v3/api-docs"},{name:"output",type:"text",message:"\u8F93\u51FA\u5730\u5740:",initial:e.param.output??"./src/api"},{name:"name",type:"text",message:"\u6587\u4EF6\u540D:",initial:e.param.name??"index"}])),[e.param.url,e.param.output,e.param.name].includes(void 0)&&g("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA"),p.docFile=u.resolve(`${e.param.output}/${e.param.name}-${new Date().getTime()}.json`)}async function v(t=0){if(e.file=e.files[t],await k(),y(e.param.url))await S.get(e.param.url).then(r=>x(r.data)).catch(r=>console.log("\u5931\u8D25\uFF1A",r));else try{await x(JSON.parse(d.readFileSync(u.resolve(e.param.url),"utf8")))}catch(r){console.log("\u5931\u8D25\uFF1A",r)}e.files[t+1]&&v(t+1)}async function x(t){if(typeof t?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(t.paths).forEach(r=>{Object.keys(r[1]).forEach(i=>{let s=`${r[0]}/${i}`;if(a(["--convert-get","-cg"])&&(s=s.replace(/([^\}]\/)get$/g,"$1query")),a(["--remove-param","-rp"])&&(s=s.replace(/\/\{.+?\}/g,"")),n(["--remove-prefix-index","-rpi"])){let o=s.split("/");o=o.slice(0,1).concat(o.slice(Number(n(["--remove-prefix-index","-rpi"]))+2)),s=o.join("/")}t.paths[r[0]][i].operationId=s;let m=s.split("/").slice(-1)[0];typeof p.enum[m]=="number"?p.enum[m]++:p.enum[m]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(p.enum).map(r=>r.join("-"))),f(p.docFile,JSON.stringify(t)),console.log("\u6267\u884C\uFF1A",e.file),await F({fileName:`${e.param.name}.ts`,output:u.resolve(e.param.output),input:p.docFile,templates:n(["--templates","-t"]),defaultResponseAsSuccess:a(["--default-as-success","-d"]),generateResponses:a(["--responses","-r"]),generateUnionEnums:a("--union-enums"),addReadonly:a("--add-readonly"),generateRouteTypes:a("--route-types"),generateClient:!a("--no-client"),enumNamesAsValues:a("--enum-names-as-values"),extractRequestParams:a("--extract-request-params"),extractRequestBody:a("--extract-request-body"),extractResponseBody:a("--extract-response-body"),extractResponseError:a("--extract-response-error"),modular:a("--modular"),toJS:a("--js"),moduleNameIndex:Number(n("--module-name-index")??0),moduleNameFirstTag:a("--module-name-first-tag"),httpClientType:a("--axios")?"axios":"fetch",unwrapResponseData:a("--unwrap-response-data"),disableThrowOnError:a("--disable-throw-on-error"),singleHttpClient:a("--single-http-client"),silent:a("--silent"),defaultResponseType:n("--default-response")??"void",typePrefix:n("--type-prefix")??"",typeSuffix:n("--type-suffix")??"",cleanOutput:a("--clean-output"),...n("--api-class-name")?{apiClassName:n("--api-class-name")}:{},patch:a("--patch"),debug:a("--debug"),anotherArrayType:a("--another-array-type"),sortTypes:a("--sort-types"),extractEnums:a("--extract-enums")}),d.unlinkSync(p.docFile),a(["--remove-dts","-rd"])&&(console.log("\u6E05\u7406\uFF1A",u.resolve(e.param.output,`${e.param.name}.d.ts`)),j(`npx rimraf ${u.resolve(e.param.output,`${e.param.name}.d.ts`)}`,{cwd:p.home}).toString()),f(e.file,JSON.stringify(e.param,null,2))}async function G(){await $(),v()}export{G as generateApi};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fxri/swagger2api",
3
- "version": "1.0.15",
3
+ "version": "1.1.1",
4
4
  "description": "基于 swagger-typescript-api,将 Swagger 文档自动转为 TypeScript 格式的 API 文件。",
5
5
  "license": "MIT",
6
6
  "author": {
@@ -10,32 +10,37 @@
10
10
  },
11
11
  "type": "module",
12
12
  "main": "./dist/index.js",
13
- "bin": {
14
- "@fxri/swagger2api": "./dist/index.js"
15
- },
13
+ "bin": "./dist/bin/index.js",
16
14
  "files": [
17
15
  "dist",
18
16
  "README.md",
19
- ".swaggerrc",
20
17
  "package.json"
21
18
  ],
22
- "keywords": [],
19
+ "keywords": [
20
+ "swagger",
21
+ "typescript",
22
+ "api"
23
+ ],
23
24
  "dependencies": {
24
25
  "axios": "^1.12.2",
26
+ "glob": "^11.0.3",
25
27
  "prompts": "^2.4.2",
26
- "swagger-typescript-api": "^13.2.14"
28
+ "swagger-typescript-api": "^13.2.15"
27
29
  },
28
30
  "devDependencies": {
29
- "@types/node": "^24.2.0",
31
+ "@types/node": "^20.19.21",
30
32
  "@types/prompts": "^2.4.9",
31
- "@typescript-eslint/eslint-plugin": "^6.6.0",
32
- "@typescript-eslint/parser": "^6.6.0",
33
- "eslint": "^8.11.0",
34
- "eslint-config-prettier": "^9.0.0",
35
- "eslint-plugin-vue": "^9.0.0",
36
- "rimraf": "^6.0.1",
33
+ "@typescript-eslint/eslint-plugin": "^6.21.0",
34
+ "@typescript-eslint/parser": "^6.21.0",
35
+ "eslint": "^8.57.1",
36
+ "eslint-config-prettier": "^9.1.2",
37
+ "eslint-plugin-vue": "^9.33.0",
38
+ "tsup": "^8.5.0",
37
39
  "typescript": "^5.9.3"
38
40
  },
41
+ "engines": {
42
+ "node": ">=20"
43
+ },
39
44
  "publishConfig": {
40
45
  "registry": "https://registry.npmjs.org/"
41
46
  },
@@ -48,9 +53,9 @@
48
53
  "url": "https://github.com/fxri-net/swagger2api/issues"
49
54
  },
50
55
  "scripts": {
51
- "dev": "pnpm build && node ./dist/index.js",
52
- "prebuild": "rimraf dist",
53
- "build": "tsc",
56
+ "dev": "pnpm build:debug && node ./dist/bin/index.js",
57
+ "build": "NODE_ENV=production tsup",
58
+ "build:debug": "NODE_ENV=development tsup",
54
59
  "release": "pnpm build && pnpm publish",
55
60
  "api": "pnpm dev --axios --responses --remove-prefix-index 0"
56
61
  }
package/.swaggerrc DELETED
@@ -1,5 +0,0 @@
1
- {
2
- "url": "http://develop-daggoo-technology.daggoo-k8s.com/backend/pub/v3/api-docs",
3
- "output": "./src/api",
4
- "name": "index"
5
- }