@fxri/swagger2api 1.1.4 → 1.1.6
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 +6 -45
- package/dist/bin/index.cjs +1 -1
- package/dist/bin/index.js +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.js +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
|
|
25
25
|
### 多文档配置
|
|
26
26
|
|
|
27
|
-
1
|
|
27
|
+
1.默认配置文件为saconfig.json,项目启动后会扫描当前项目下所有符合【./**/saconfig*.json】规则的文件(如【saconfig.json】【saconfig.admin.json】【config/saconfig.json】等),并在扫描到多个文件时提供选择列表,如只有一个文件,则直接进入下一步,该功能可在配置项中关闭。
|
|
28
28
|
|
|
29
29
|
2.此功能扩展使用的话,可以作为一个独立工具使用,同时管理多个项目的接口配置。
|
|
30
30
|
|
|
@@ -96,9 +96,9 @@ npx @fxri/swagger2api
|
|
|
96
96
|
|
|
97
97
|
```json
|
|
98
98
|
{
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
99
|
+
"url": "https://example.com/v3/api-docs",
|
|
100
|
+
"output": "./src/api",
|
|
101
|
+
"name": "index"
|
|
102
102
|
}
|
|
103
103
|
```
|
|
104
104
|
|
|
@@ -130,6 +130,8 @@ api.getUsers().then((res) => console.log(res))
|
|
|
130
130
|
| `--remove-param,-rp` | boolean | `false` | 移除{.+}参数 |
|
|
131
131
|
| `--remove-prefix-index,-rpi` | number | `-1` | 移除前缀索引 |
|
|
132
132
|
| `--remove-dts,-rd` | boolean | `false` | 移除使用--js参数时生成的d.ts文件 |
|
|
133
|
+
| `--extract-request-query,-erq` | string | - | 提取参数,将query参数中的指定对象字段提取为根部字段,支持多选,用【,】分隔,每个接口只提取第一次命中的字段 |
|
|
134
|
+
| `--extract-response-raw,-err` | boolean | `false` | 提取响应,将AxiosResponse返回值转移到raw字段,根部字段自己定义 |
|
|
133
135
|
|
|
134
136
|
扩展:[更多 swagger-typescript-api 配置选项](https://fig.io/manual/swagger-typescript-api)
|
|
135
137
|
|
|
@@ -149,39 +151,6 @@ npx @fxri/swagger2api [--quick,-q] [--quick,-q <boolean>]
|
|
|
149
151
|
npx swagger2api [--config,-c <path>]
|
|
150
152
|
|
|
151
153
|
npx @fxri/swagger2api [--config,-c <path>]
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
```bash
|
|
155
|
-
# 加载全部配置文件,不进行选择
|
|
156
|
-
|
|
157
|
-
npx swagger2api [--config-all,-ca] [--config-all,-ca <boolean>]
|
|
158
|
-
|
|
159
|
-
npx @fxri/swagger2api [--config-all,-ca] [--config-all,-ca <boolean>]
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
```bash
|
|
163
|
-
# 扫描全部配置文件,并提供选择列表,该参数默认为true
|
|
164
|
-
|
|
165
|
-
npx swagger2api [--config-scan,-cs] [--config-scan,-cs <boolean>]
|
|
166
|
-
|
|
167
|
-
npx @fxri/swagger2api [--config-scan,-cs] [--config-scan,-cs <boolean>]
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
```bash
|
|
171
|
-
# 转换无{.+}get为query
|
|
172
|
-
|
|
173
|
-
npx swagger2api [--convert-get,-cg] [--convert-get,-cg <boolean>]
|
|
174
|
-
|
|
175
|
-
npx @fxri/swagger2api [--convert-get,-cg] [--convert-get,-cg <boolean>]
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
```bash
|
|
179
|
-
# 移除{.+}参数
|
|
180
|
-
|
|
181
|
-
npx swagger2api [--remove-param,-rp] [--remove-param,-rp <boolean>]
|
|
182
|
-
|
|
183
|
-
npx @fxri/swagger2api [--remove-param,-rp] [--remove-param,-rp <boolean>]
|
|
184
|
-
```
|
|
185
154
|
|
|
186
155
|
```bash
|
|
187
156
|
# 移除前缀索引
|
|
@@ -191,14 +160,6 @@ npx swagger2api [--remove-prefix-index,-rpi <number>]
|
|
|
191
160
|
npx @fxri/swagger2api [--remove-prefix-index,-rpi <number>]
|
|
192
161
|
```
|
|
193
162
|
|
|
194
|
-
```bash
|
|
195
|
-
# 移除使用--js参数时生成的d.ts文件
|
|
196
|
-
|
|
197
|
-
npx swagger2api [--remove-dts,-rd] [--remove-dts,-rd <boolean>]
|
|
198
|
-
|
|
199
|
-
npx @fxri/swagger2api [--remove-dts,-rd] [--remove-dts,-rd <boolean>]
|
|
200
|
-
```
|
|
201
|
-
|
|
202
163
|
## 🤝 贡献
|
|
203
164
|
|
|
204
165
|
欢迎提交 Issue 和 Pull Request!
|
package/dist/bin/index.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
var $=Object.create;var h=Object.defineProperty;var F=Object.getOwnPropertyDescriptor;var D=Object.getOwnPropertyNames;var k=Object.getPrototypeOf,E=Object.prototype.hasOwnProperty;var T=(e,r,n,o)=>{if(r&&typeof r=="object"||typeof r=="function")for(let i of D(r))!E.call(e,i)&&i!==n&&h(e,i,{get:()=>r[i],enumerable:!(o=F(r,i))||o.enumerable});return e};var l=(e,r,n)=>(n=e!=null?$(k(e)):{},T(r||!e||!e.__esModule?h(n,"default",{value:e,enumerable:!0}):n,e));var P=l(require("axios"),1),j=require("child_process"),q=l(require("os"),1),g=l(require("fs"),1),u=l(require("path"),1),x=l(require("prompts"),1),R=require("swagger-typescript-api");var v=e=>/^(https?:\/\/|:?\/\/)/.test(e);var f=l(require("fs"),1),b=l(require("path"),1),c={param:process.argv.filter((e,r)=>r>1),used:{}};function w(e,r=!0,n=!0){Array.isArray(e)||(e=[e]);let o;return c.param.forEach((i,p)=>{if(e.includes(i))r?(o=c.param[p+1],n&&Object.assign(c.used,{[p+1]:!0})):["true","false"].includes(c.param[p+1])?(o=c.param[p+1].toLowerCase()=="true",n&&Object.assign(c.used,{[p+1]:!0})):o=!0;else return;n&&Object.assign(c.used,{[p]:!0})}),o}function t(e,r=!0){return w(e,!1,r)}function m(e,r=!0){return w(e,!0,r)}function d(e,r){let n=b.default.dirname(e);f.default.existsSync(n)||f.default.mkdirSync(n,{recursive:!0}),f.default.writeFileSync(e,r)}var A=require("glob"),a={files:[],param:{}},s={home:q.default.homedir(),enum:{}};function y(e){e&&console.log(e),process.exit()}async function C(){s.config={templates:m(["--templates","-t"])??"./src/templates",defaultResponseAsSuccess:t(["--default-as-success","-d"]),generateResponses:t(["--responses","-r"]),generateUnionEnums:t("--union-enums"),addReadonly:t("--add-readonly"),generateRouteTypes:t("--route-types"),generateClient:!t("--no-client"),enumNamesAsValues:t("--enum-names-as-values"),extractRequestParams:t("--extract-request-params"),extractRequestBody:t("--extract-request-body"),extractResponseBody:t("--extract-response-body"),extractResponseError:t("--extract-response-error"),modular:t("--modular"),toJS:t("--js"),moduleNameIndex:Number(m("--module-name-index")??0),moduleNameFirstTag:t("--module-name-first-tag"),httpClientType:t("--axios")?"axios":"fetch",unwrapResponseData:t("--unwrap-response-data"),disableThrowOnError:t("--disable-throw-on-error"),singleHttpClient:t("--single-http-client"),silent:t("--silent"),defaultResponseType:m("--default-response")??"void",typePrefix:m("--type-prefix")??"",typeSuffix:m("--type-suffix")??"",cleanOutput:t("--clean-output"),...m("--api-class-name")?{apiClassName:m("--api-class-name")}:{},patch:t("--patch"),debug:t("--debug"),anotherArrayType:t("--another-array-type"),sortTypes:t("--sort-types"),extractEnums:t("--extract-enums")},s.param={config:m(["--config","-c"]),configScan:t(["--config-scan","-cs"]),configAll:t(["--config-all","-ca"]),quick:t(["--quick","-q"]),convertGet:t(["--convert-get","-cg"]),removeParam:t(["--remove-param","-rp"]),removePrefixIndex:m(["--remove-prefix-index","-rpi"]),removeDts:t(["--remove-dts","-rd"]),extractRequestQuery:m(["--extract-request-query","-erq"]),extractResponseRaw:t(["--extract-response-raw","-err"])}}async function I(){s.param.config?a.files=s.param.config.split(","):(s.param.configScan??!0)&&(a.files=A.glob.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),a.files.length==0&&(a.files=["saconfig.json"]),!s.param.configAll&&a.files.length>1&&(a.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:a.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),a.files?.length>0||y("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA")}async function J(){try{a.param={},a.param=JSON.parse(g.default.readFileSync(a.file,"utf-8"))}catch{}(!s.param.quick||[a.param.url,a.param.output,a.param.name].includes(void 0))&&(a.param=await(0,x.default)([{name:"url",type:"text",message:"Swagger docs \u5730\u5740:",initial:a.param.url??"https://example.com/v3/api-docs"},{name:"output",type:"text",message:"\u8F93\u51FA\u5730\u5740:",initial:a.param.output??"./src/api"},{name:"name",type:"text",message:"\u6587\u4EF6\u540D:",initial:a.param.name??"index"}])),[a.param.url,a.param.output,a.param.name].includes(void 0)&&y("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA"),s.docFile=u.default.resolve(`${a.param.output}/${a.param.name}-${new Date().getTime()}.json`)}async function O(e=0){if(a.file=a.files[e],await J(),v(a.param.url))await P.default.get(a.param.url).then(r=>S(r.data)).catch(r=>console.log("\u5931\u8D25\uFF1A",r));else try{await S(JSON.parse(g.default.readFileSync(u.default.resolve(a.param.url),"utf8")))}catch(r){console.log("\u5931\u8D25\uFF1A",r)}a.files[e+1]&&O(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 o=`${r[0]}/${n}`;if(s.param.convertGet&&(o=o.replace(/([^\}]\/)get$/g,"$1query")),s.param.removeParam&&(o=o.replace(/\/\{.+?\}/g,"")),s.param.removePrefixIndex){let p=o.split("/");p=p.slice(0,1).concat(p.slice(Number(s.param.removePrefixIndex)+2)),o=p.join("/")}e.paths[r[0]][n].operationId=o;let i=o.split("/").slice(-1)[0];typeof s.enum[i]=="number"?s.enum[i]++:s.enum[i]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(s.enum).map(r=>r.join("-"))),d(s.docFile,JSON.stringify(e)),console.log("\u6267\u884C\uFF1A",a.file),await(0,R.generateApi)({fileName:`${a.param.name}.ts`,output:u.default.resolve(a.param.output),input:s.docFile,...s.config,param:s.param}),g.default.unlinkSync(s.docFile),s.param.removeDts&&(console.log("\u6E05\u7406\uFF1A",u.default.resolve(a.param.output,`${a.param.name}.d.ts`)),(0,j.execSync)(`npx rimraf ${u.default.resolve(a.param.output,`${a.param.name}.d.ts`)}`,{cwd:s.home}).toString()),d(a.file,JSON.stringify(a.param,null,2))}async function N(){await C(),await I(),O()}N();
|
package/dist/bin/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import
|
|
1
|
+
import P from"axios";import{execSync as j}from"child_process";import q from"os";import d from"fs";import c from"path";import v from"prompts";import{generateApi as R}from"swagger-typescript-api";var y=a=>/^(https?:\/\/|:?\/\/)/.test(a);import u from"fs";import S from"path";var m={param:process.argv.filter((a,s)=>s>1),used:{}};function x(a,s=!0,p=!0){Array.isArray(a)||(a=[a]);let o;return m.param.forEach((l,n)=>{if(a.includes(l))s?(o=m.param[n+1],p&&Object.assign(m.used,{[n+1]:!0})):["true","false"].includes(m.param[n+1])?(o=m.param[n+1].toLowerCase()=="true",p&&Object.assign(m.used,{[n+1]:!0})):o=!0;else return;p&&Object.assign(m.used,{[n]:!0})}),o}function t(a,s=!0){return x(a,!1,s)}function i(a,s=!0){return x(a,!0,s)}function f(a,s){let p=S.dirname(a);u.existsSync(p)||u.mkdirSync(p,{recursive:!0}),u.writeFileSync(a,s)}import{glob as A}from"glob";var e={files:[],param:{}},r={home:q.homedir(),enum:{}};function g(a){a&&console.log(a),process.exit()}async function O(){r.config={templates:i(["--templates","-t"])??"./src/templates",defaultResponseAsSuccess:t(["--default-as-success","-d"]),generateResponses:t(["--responses","-r"]),generateUnionEnums:t("--union-enums"),addReadonly:t("--add-readonly"),generateRouteTypes:t("--route-types"),generateClient:!t("--no-client"),enumNamesAsValues:t("--enum-names-as-values"),extractRequestParams:t("--extract-request-params"),extractRequestBody:t("--extract-request-body"),extractResponseBody:t("--extract-response-body"),extractResponseError:t("--extract-response-error"),modular:t("--modular"),toJS:t("--js"),moduleNameIndex:Number(i("--module-name-index")??0),moduleNameFirstTag:t("--module-name-first-tag"),httpClientType:t("--axios")?"axios":"fetch",unwrapResponseData:t("--unwrap-response-data"),disableThrowOnError:t("--disable-throw-on-error"),singleHttpClient:t("--single-http-client"),silent:t("--silent"),defaultResponseType:i("--default-response")??"void",typePrefix:i("--type-prefix")??"",typeSuffix:i("--type-suffix")??"",cleanOutput:t("--clean-output"),...i("--api-class-name")?{apiClassName:i("--api-class-name")}:{},patch:t("--patch"),debug:t("--debug"),anotherArrayType:t("--another-array-type"),sortTypes:t("--sort-types"),extractEnums:t("--extract-enums")},r.param={config:i(["--config","-c"]),configScan:t(["--config-scan","-cs"]),configAll:t(["--config-all","-ca"]),quick:t(["--quick","-q"]),convertGet:t(["--convert-get","-cg"]),removeParam:t(["--remove-param","-rp"]),removePrefixIndex:i(["--remove-prefix-index","-rpi"]),removeDts:t(["--remove-dts","-rd"]),extractRequestQuery:i(["--extract-request-query","-erq"]),extractResponseRaw:t(["--extract-response-raw","-err"])}}async function N(){r.param.config?e.files=r.param.config.split(","):(r.param.configScan??!0)&&(e.files=A.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),e.files.length==0&&(e.files=["saconfig.json"]),!r.param.configAll&&e.files.length>1&&(e.files=(await v({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(a=>({title:a.replace(/\\/g,"/"),value:a}))}).then(a=>a.files?.length!=0?a: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 $(){try{e.param={},e.param=JSON.parse(d.readFileSync(e.file,"utf-8"))}catch{}(!r.param.quick||[e.param.url,e.param.output,e.param.name].includes(void 0))&&(e.param=await v([{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"),r.docFile=c.resolve(`${e.param.output}/${e.param.name}-${new Date().getTime()}.json`)}async function b(a=0){if(e.file=e.files[a],await $(),y(e.param.url))await P.get(e.param.url).then(s=>h(s.data)).catch(s=>console.log("\u5931\u8D25\uFF1A",s));else try{await h(JSON.parse(d.readFileSync(c.resolve(e.param.url),"utf8")))}catch(s){console.log("\u5931\u8D25\uFF1A",s)}e.files[a+1]&&b(a+1)}async function h(a){if(typeof a?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(a.paths).forEach(s=>{Object.keys(s[1]).forEach(p=>{let o=`${s[0]}/${p}`;if(r.param.convertGet&&(o=o.replace(/([^\}]\/)get$/g,"$1query")),r.param.removeParam&&(o=o.replace(/\/\{.+?\}/g,"")),r.param.removePrefixIndex){let n=o.split("/");n=n.slice(0,1).concat(n.slice(Number(r.param.removePrefixIndex)+2)),o=n.join("/")}a.paths[s[0]][p].operationId=o;let l=o.split("/").slice(-1)[0];typeof r.enum[l]=="number"?r.enum[l]++:r.enum[l]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(r.enum).map(s=>s.join("-"))),f(r.docFile,JSON.stringify(a)),console.log("\u6267\u884C\uFF1A",e.file),await R({fileName:`${e.param.name}.ts`,output:c.resolve(e.param.output),input:r.docFile,...r.config,param:r.param}),d.unlinkSync(r.docFile),r.param.removeDts&&(console.log("\u6E05\u7406\uFF1A",c.resolve(e.param.output,`${e.param.name}.d.ts`)),j(`npx rimraf ${c.resolve(e.param.output,`${e.param.name}.d.ts`)}`,{cwd:r.home}).toString()),f(e.file,JSON.stringify(e.param,null,2))}async function w(){await O(),await N(),b()}w();
|
package/dist/index.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
var $=Object.create;var f=Object.defineProperty;var F=Object.getOwnPropertyDescriptor;var D=Object.getOwnPropertyNames;var k=Object.getPrototypeOf,E=Object.prototype.hasOwnProperty;var T=(e,t)=>{for(var o in t)f(e,o,{get:t[o],enumerable:!0})},v=(e,t,o,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of D(t))!E.call(e,i)&&i!==o&&f(e,i,{get:()=>t[i],enumerable:!(n=F(t,i))||n.enumerable});return e};var l=(e,t,o)=>(o=e!=null?$(k(e)):{},v(t||!e||!e.__esModule?f(o,"default",{value:e,enumerable:!0}):o,e)),C=e=>v(f({},"__esModule",{value:!0}),e);var U={};T(U,{generateApi:()=>G});module.exports=C(U);var j=l(require("axios"),1),q=require("child_process"),R=l(require("os"),1),d=l(require("fs"),1),u=l(require("path"),1),h=l(require("prompts"),1),O=require("swagger-typescript-api");var b=e=>/^(https?:\/\/|:?\/\/)/.test(e);var g=l(require("fs"),1),w=l(require("path"),1),c={param:process.argv.filter((e,t)=>t>1),used:{}};function S(e,t=!0,o=!0){Array.isArray(e)||(e=[e]);let n;return c.param.forEach((i,p)=>{if(e.includes(i))t?(n=c.param[p+1],o&&Object.assign(c.used,{[p+1]:!0})):["true","false"].includes(c.param[p+1])?(n=c.param[p+1].toLowerCase()=="true",o&&Object.assign(c.used,{[p+1]:!0})):n=!0;else return;o&&Object.assign(c.used,{[p]:!0})}),n}function r(e,t=!0){return S(e,!1,t)}function m(e,t=!0){return S(e,!0,t)}function y(e,t){let o=w.default.dirname(e);g.default.existsSync(o)||g.default.mkdirSync(o,{recursive:!0}),g.default.writeFileSync(e,t)}var A=require("glob"),a={files:[],param:{}},s={home:R.default.homedir(),enum:{}};function x(e){e&&console.log(e),process.exit()}async function I(){s.config={templates:m(["--templates","-t"])??"./src/templates",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(m("--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:m("--default-response")??"void",typePrefix:m("--type-prefix")??"",typeSuffix:m("--type-suffix")??"",cleanOutput:r("--clean-output"),...m("--api-class-name")?{apiClassName:m("--api-class-name")}:{},patch:r("--patch"),debug:r("--debug"),anotherArrayType:r("--another-array-type"),sortTypes:r("--sort-types"),extractEnums:r("--extract-enums")},s.param={config:m(["--config","-c"]),configScan:r(["--config-scan","-cs"]),configAll:r(["--config-all","-ca"]),quick:r(["--quick","-q"]),convertGet:r(["--convert-get","-cg"]),removeParam:r(["--remove-param","-rp"]),removePrefixIndex:m(["--remove-prefix-index","-rpi"]),removeDts:r(["--remove-dts","-rd"]),extractRequestQuery:m(["--extract-request-query","-erq"]),extractResponseRaw:r(["--extract-response-raw","-err"])}}async function J(){s.param.config?a.files=s.param.config.split(","):(s.param.configScan??!0)&&(a.files=A.glob.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),a.files.length==0&&(a.files=["saconfig.json"]),!s.param.configAll&&a.files.length>1&&(a.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:a.files.map(e=>({title:e.replace(/\\/g,"/"),value:e}))}).then(e=>e.files?.length!=0?e:x("\u7ED3\u675F\uFF1A\u81F3\u5C11\u9009\u62E9\u4E00\u4E2A\u914D\u7F6E\u6587\u4EF6"))).files),a.files?.length>0||x("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA")}async function L(){try{a.param={},a.param=JSON.parse(d.default.readFileSync(a.file,"utf-8"))}catch{}(!s.param.quick||[a.param.url,a.param.output,a.param.name].includes(void 0))&&(a.param=await(0,h.default)([{name:"url",type:"text",message:"Swagger docs \u5730\u5740:",initial:a.param.url??"https://example.com/v3/api-docs"},{name:"output",type:"text",message:"\u8F93\u51FA\u5730\u5740:",initial:a.param.output??"./src/api"},{name:"name",type:"text",message:"\u6587\u4EF6\u540D:",initial:a.param.name??"index"}])),[a.param.url,a.param.output,a.param.name].includes(void 0)&&x("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA"),s.docFile=u.default.resolve(`${a.param.output}/${a.param.name}-${new Date().getTime()}.json`)}async function N(e=0){if(a.file=a.files[e],await L(),b(a.param.url))await j.default.get(a.param.url).then(t=>P(t.data)).catch(t=>console.log("\u5931\u8D25\uFF1A",t));else try{await P(JSON.parse(d.default.readFileSync(u.default.resolve(a.param.url),"utf8")))}catch(t){console.log("\u5931\u8D25\uFF1A",t)}a.files[e+1]&&N(e+1)}async function P(e){if(typeof e?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(e.paths).forEach(t=>{Object.keys(t[1]).forEach(o=>{let n=`${t[0]}/${o}`;if(s.param.convertGet&&(n=n.replace(/([^\}]\/)get$/g,"$1query")),s.param.removeParam&&(n=n.replace(/\/\{.+?\}/g,"")),s.param.removePrefixIndex){let p=n.split("/");p=p.slice(0,1).concat(p.slice(Number(s.param.removePrefixIndex)+2)),n=p.join("/")}e.paths[t[0]][o].operationId=n;let i=n.split("/").slice(-1)[0];typeof s.enum[i]=="number"?s.enum[i]++:s.enum[i]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(s.enum).map(t=>t.join("-"))),y(s.docFile,JSON.stringify(e)),console.log("\u6267\u884C\uFF1A",a.file),await(0,O.generateApi)({fileName:`${a.param.name}.ts`,output:u.default.resolve(a.param.output),input:s.docFile,...s.config,param:s.param}),d.default.unlinkSync(s.docFile),s.param.removeDts&&(console.log("\u6E05\u7406\uFF1A",u.default.resolve(a.param.output,`${a.param.name}.d.ts`)),(0,q.execSync)(`npx rimraf ${u.default.resolve(a.param.output,`${a.param.name}.d.ts`)}`,{cwd:s.home}).toString()),y(a.file,JSON.stringify(a.param,null,2))}async function G(){await I(),await J(),N()}0&&(module.exports={generateApi});
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import S from"axios";import{execSync as
|
|
1
|
+
import S from"axios";import{execSync as P}from"child_process";import j from"os";import d from"fs";import c from"path";import v from"prompts";import{generateApi as q}from"swagger-typescript-api";var y=a=>/^(https?:\/\/|:?\/\/)/.test(a);import u from"fs";import w from"path";var m={param:process.argv.filter((a,s)=>s>1),used:{}};function x(a,s=!0,p=!0){Array.isArray(a)||(a=[a]);let o;return m.param.forEach((l,n)=>{if(a.includes(l))s?(o=m.param[n+1],p&&Object.assign(m.used,{[n+1]:!0})):["true","false"].includes(m.param[n+1])?(o=m.param[n+1].toLowerCase()=="true",p&&Object.assign(m.used,{[n+1]:!0})):o=!0;else return;p&&Object.assign(m.used,{[n]:!0})}),o}function t(a,s=!0){return x(a,!1,s)}function i(a,s=!0){return x(a,!0,s)}function f(a,s){let p=w.dirname(a);u.existsSync(p)||u.mkdirSync(p,{recursive:!0}),u.writeFileSync(a,s)}import{glob as R}from"glob";var e={files:[],param:{}},r={home:j.homedir(),enum:{}};function g(a){a&&console.log(a),process.exit()}async function O(){r.config={templates:i(["--templates","-t"])??"./src/templates",defaultResponseAsSuccess:t(["--default-as-success","-d"]),generateResponses:t(["--responses","-r"]),generateUnionEnums:t("--union-enums"),addReadonly:t("--add-readonly"),generateRouteTypes:t("--route-types"),generateClient:!t("--no-client"),enumNamesAsValues:t("--enum-names-as-values"),extractRequestParams:t("--extract-request-params"),extractRequestBody:t("--extract-request-body"),extractResponseBody:t("--extract-response-body"),extractResponseError:t("--extract-response-error"),modular:t("--modular"),toJS:t("--js"),moduleNameIndex:Number(i("--module-name-index")??0),moduleNameFirstTag:t("--module-name-first-tag"),httpClientType:t("--axios")?"axios":"fetch",unwrapResponseData:t("--unwrap-response-data"),disableThrowOnError:t("--disable-throw-on-error"),singleHttpClient:t("--single-http-client"),silent:t("--silent"),defaultResponseType:i("--default-response")??"void",typePrefix:i("--type-prefix")??"",typeSuffix:i("--type-suffix")??"",cleanOutput:t("--clean-output"),...i("--api-class-name")?{apiClassName:i("--api-class-name")}:{},patch:t("--patch"),debug:t("--debug"),anotherArrayType:t("--another-array-type"),sortTypes:t("--sort-types"),extractEnums:t("--extract-enums")},r.param={config:i(["--config","-c"]),configScan:t(["--config-scan","-cs"]),configAll:t(["--config-all","-ca"]),quick:t(["--quick","-q"]),convertGet:t(["--convert-get","-cg"]),removeParam:t(["--remove-param","-rp"]),removePrefixIndex:i(["--remove-prefix-index","-rpi"]),removeDts:t(["--remove-dts","-rd"]),extractRequestQuery:i(["--extract-request-query","-erq"]),extractResponseRaw:t(["--extract-response-raw","-err"])}}async function A(){r.param.config?e.files=r.param.config.split(","):(r.param.configScan??!0)&&(e.files=R.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),e.files.length==0&&(e.files=["saconfig.json"]),!r.param.configAll&&e.files.length>1&&(e.files=(await v({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(a=>({title:a.replace(/\\/g,"/"),value:a}))}).then(a=>a.files?.length!=0?a: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 N(){try{e.param={},e.param=JSON.parse(d.readFileSync(e.file,"utf-8"))}catch{}(!r.param.quick||[e.param.url,e.param.output,e.param.name].includes(void 0))&&(e.param=await v([{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"),r.docFile=c.resolve(`${e.param.output}/${e.param.name}-${new Date().getTime()}.json`)}async function b(a=0){if(e.file=e.files[a],await N(),y(e.param.url))await S.get(e.param.url).then(s=>h(s.data)).catch(s=>console.log("\u5931\u8D25\uFF1A",s));else try{await h(JSON.parse(d.readFileSync(c.resolve(e.param.url),"utf8")))}catch(s){console.log("\u5931\u8D25\uFF1A",s)}e.files[a+1]&&b(a+1)}async function h(a){if(typeof a?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(a.paths).forEach(s=>{Object.keys(s[1]).forEach(p=>{let o=`${s[0]}/${p}`;if(r.param.convertGet&&(o=o.replace(/([^\}]\/)get$/g,"$1query")),r.param.removeParam&&(o=o.replace(/\/\{.+?\}/g,"")),r.param.removePrefixIndex){let n=o.split("/");n=n.slice(0,1).concat(n.slice(Number(r.param.removePrefixIndex)+2)),o=n.join("/")}a.paths[s[0]][p].operationId=o;let l=o.split("/").slice(-1)[0];typeof r.enum[l]=="number"?r.enum[l]++:r.enum[l]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(r.enum).map(s=>s.join("-"))),f(r.docFile,JSON.stringify(a)),console.log("\u6267\u884C\uFF1A",e.file),await q({fileName:`${e.param.name}.ts`,output:c.resolve(e.param.output),input:r.docFile,...r.config,param:r.param}),d.unlinkSync(r.docFile),r.param.removeDts&&(console.log("\u6E05\u7406\uFF1A",c.resolve(e.param.output,`${e.param.name}.d.ts`)),P(`npx rimraf ${c.resolve(e.param.output,`${e.param.name}.d.ts`)}`,{cwd:r.home}).toString()),f(e.file,JSON.stringify(e.param,null,2))}async function Q(){await O(),await A(),b()}export{Q as generateApi};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fxri/swagger2api",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.6",
|
|
4
4
|
"description": "基于 swagger-typescript-api,将 Swagger 文档自动转为 TypeScript 格式的 API 文件。",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": {
|
|
@@ -55,8 +55,8 @@
|
|
|
55
55
|
"scripts": {
|
|
56
56
|
"dev": "pnpm build:debug && node ./dist/bin/index.js",
|
|
57
57
|
"build": "NODE_ENV=production tsup",
|
|
58
|
-
"build:debug": "NODE_ENV=development tsup",
|
|
58
|
+
"build:debug": "NODE_ENV=development tsup --config tsup.debug.config.ts",
|
|
59
59
|
"release": "pnpm build && pnpm publish",
|
|
60
|
-
"api": "pnpm dev --axios --responses --remove-prefix-index 0"
|
|
60
|
+
"api": "pnpm dev --axios --responses --remove-prefix-index 0 --quick"
|
|
61
61
|
}
|
|
62
62
|
}
|