@fxri/swagger2api 1.1.12 → 1.2.0
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 +5 -2
- package/dist/cli.cjs +1 -1
- package/dist/cli.js +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.js +1 -1
- package/dist/templates/route-types.ejs +32 -32
- package/dist/templates/type-data-contract.ejs +15 -15
- package/package.json +7 -2
package/README.md
CHANGED
|
@@ -119,7 +119,7 @@ request.getUsers().then((res) => console.log(res))
|
|
|
119
119
|
|
|
120
120
|
```typescript
|
|
121
121
|
declare module "." {
|
|
122
|
-
interface AxiosResponse<T = any> {
|
|
122
|
+
interface AxiosResponse<T extends Record<string, any> = any> {
|
|
123
123
|
/** 状态代码 */
|
|
124
124
|
code: number
|
|
125
125
|
/** 提示信息 */
|
|
@@ -158,6 +158,7 @@ client.instance.interceptors.response.use(
|
|
|
158
158
|
| `--remove-param,-rp` | boolean | `false` | 移除{.+}参数 |
|
|
159
159
|
| `--remove-prefix-index,-rpi` | number | `-1` | 移除前缀索引 |
|
|
160
160
|
| `--remove-dts,-rd` | boolean | `false` | 移除使用--js参数时生成的d.ts文件 |
|
|
161
|
+
| `--remove-empty-components,-rec` | boolean | `true` | 移除空组件定义 |
|
|
161
162
|
| `--extract-request-query,-erq` | string | - | 提取参数,将query参数中的指定对象字段提取为根部字段,支持多选,用【,】分隔,每个接口只提取第一次命中的字段 |
|
|
162
163
|
| `--extract-response-raw,-err` | boolean | `false` | 提取响应,将AxiosResponse返回值转移到raw字段,根部字段自行定义,使用该参数需在响应拦截中重新设计实际的返回值 |
|
|
163
164
|
|
|
@@ -209,4 +210,6 @@ npx @fxri/swagger2api [--replace-tags,-rt <regexp> <substr>]
|
|
|
209
210
|
|
|
210
211
|
网站:[方弦研究信息网](https://fxri.net:444/)
|
|
211
212
|
|
|
212
|
-
协议:MIT License
|
|
213
|
+
协议:[MIT License](./LICENSE)
|
|
214
|
+
|
|
215
|
+
商标:"方弦™"为第 42 类商标(注册号 89648411),本开源许可不授予商标使用权,详见 [TRADEMARK.md](./TRADEMARK.md)
|
package/dist/cli.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
var F=Object.create;var b=Object.defineProperty;var N=Object.getOwnPropertyDescriptor;var C=Object.getOwnPropertyNames;var J=Object.getPrototypeOf,_=Object.prototype.hasOwnProperty;var I=(e,r,o,s)=>{if(r&&typeof r=="object"||typeof r=="function")for(let i of C(r))!_.call(e,i)&&i!==o&&b(e,i,{get:()=>r[i],enumerable:!(s=N(r,i))||s.enumerable});return e};var c=(e,r,o)=>(o=e!=null?F(J(e)):{},I(r||!e||!e.__esModule?b(o,"default",{value:e,enumerable:!0}):o,e));var q=c(require("axios"),1),A=require("child_process"),j=c(require("os"),1),g=c(require("fs"),1),l=c(require("path"),1),v=c(require("prompts"),1),E=require("swagger-typescript-api");var S=e=>/^(https?:\/\/|:?\/\/)/.test(e);var f=c(require("fs"),1),w=c(require("url"),1),d=c(require("path"),1),U={},u={param:process.argv.filter((e,r)=>r>1)};function y(e,r="value",o={}){Array.isArray(e)||(e=[e]);let s;return u.param.forEach((i,m)=>{if(e.includes(i))["value"].includes(r)?s=u.param[m+1]:["array"].includes(r)?s=Array.from({length:o.length??1}).map((K,D)=>u.param[m+D+1]):s=!["false"].includes(u.param[m+1]);else return}),s}function t(e){return y(e,"key")}function p(e){return y(e,"value")}function P(e,r={}){return y(e,"array",r)??[]}function x(e,r){let o=d.default.dirname(e);f.default.existsSync(o)||f.default.mkdirSync(o,{recursive:!0}),f.default.writeFileSync(e,r)}function L(){return typeof require<"u"&&typeof module<"u"?__filename:w.default.fileURLToPath(U.url)}function R(){return typeof require<"u"&&typeof module<"u"?__dirname:d.default.dirname(L())}var T=require("glob"),a={files:[],param:{}},n={home:j.default.homedir(),enum:{}};function h(e){e&&console.log(e),process.exit()}async function G(){n.param={config:p(["--config","-c"]),configScan:t(["--config-scan","-cs"])??!0,configAll:t(["--config-all","-ca"]),quick:t(["--quick","-q"]),replaceTags:P(["--replace-tags","-rt"],{length:2}),convertGet:t(["--convert-get","-cg"]),removeParam:t(["--remove-param","-rp"]),removePrefixIndex:p(["--remove-prefix-index","-rpi"]),removeDts:t(["--remove-dts","-rd"]),removeEmptyComponents:t(["--remove-empty-components","-rec"])??!0,extractRequestQuery:p(["--extract-request-query","-erq"]),extractResponseRaw:t(["--extract-response-raw","-err"]),template:l.default.resolve(R(),"./templates")},n.config={templates:p(["--templates","-t"])??n.param.template,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(p("--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")??!0,defaultResponseType:p("--default-response")??"void",typePrefix:p("--type-prefix")??"",typeSuffix:p("--type-suffix")??"",cleanOutput:t("--clean-output"),...p("--api-class-name")?{apiClassName:p("--api-class-name")}:{},patch:t("--patch"),debug:t("--debug"),anotherArrayType:t("--another-array-type"),sortTypes:t("--sort-types"),extractEnums:t("--extract-enums")}}async function V(){n.param.config?a.files=n.param.config.split(","):n.param.configScan&&(a.files=T.glob.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),a.files.length==0&&(a.files=["saconfig.json"]),!n.param.configAll&&a.files.length>1&&(a.files=(await(0,v.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:h("\u7ED3\u675F\uFF1A\u81F3\u5C11\u9009\u62E9\u4E00\u4E2A\u914D\u7F6E\u6587\u4EF6"))).files),a.files?.length>0||h("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA")}async function B(){try{a.param={},a.param=JSON.parse(g.default.readFileSync(a.file,"utf-8"))}catch{}(!n.param.quick||[a.param.url,a.param.output,a.param.name].includes(void 0))&&(a.param=await(0,v.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)&&h("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA"),n.docFile=l.default.resolve(`${a.param.output}/${a.param.name}-${new Date().getTime()}.json`)}async function O(e=0){if(a.file=a.files[e],await B(),S(a.param.url))await q.default.get(a.param.url).then(r=>$(r.data)).catch(r=>console.log("\u5931\u8D25\uFF1A",r));else try{await $(JSON.parse(g.default.readFileSync(l.default.resolve(a.param.url),"utf8")))}catch(r){console.log("\u5931\u8D25\uFF1A",r)}a.files[e+1]&&O(e+1)}async function $(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(o=>{n.param.replaceTags.length&&(e.paths[r[0]][o].tags=e.paths[r[0]][o].tags?.map(m=>m.replace(new RegExp(`^${n.param.replaceTags[0]}$`,"g"),n.param.replaceTags[1]??"")));let s=`${r[0]}/${o}`;if(n.param.convertGet&&(s=s.replace(/([^\}]\/)get$/g,"$1query")),n.param.removeParam&&(s=s.replace(/\/\{.+?\}/g,"")),n.param.removePrefixIndex){let m=s.split("/");m=m.slice(0,1).concat(m.slice(Number(n.param.removePrefixIndex)+2)),s=m.join("/")}e.paths[r[0]][o].operationId=s;let i=s.split("/").slice(-1)[0];typeof n.enum[i]=="number"?n.enum[i]++:n.enum[i]=1})}),Object.entries(e.components).forEach(r=>{Object.keys(r[1]).forEach(o=>{n.param.removeEmptyComponents&&!Object.keys(e.components[r[0]][o]).length&&delete e.components[r[0]][o]})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(n.enum).map(r=>r.join("-"))),x(n.docFile,JSON.stringify(e)),console.log("\u6267\u884C\uFF1A",a.file),await(0,E.generateApi)({fileName:`${a.param.name}.ts`,output:l.default.resolve(a.param.output),input:n.docFile,...n.config,param:n.param}),console.log("\u5B8C\u6210\uFF1A",l.default.resolve(a.param.output,`${a.param.name}${n.config.toJS?".js":".ts"}`)),n.config.toJS&&console.log("\u5B8C\u6210\uFF1A",l.default.resolve(a.param.output,`${a.param.name}.d.ts`)),g.default.unlinkSync(n.docFile),n.param.removeDts&&(console.log("\u6E05\u7406\uFF1A",l.default.resolve(a.param.output,`${a.param.name}.d.ts`)),(0,A.execSync)(`npx rimraf ${l.default.resolve(a.param.output,`${a.param.name}.d.ts`)}`,{cwd:n.home}).toString()),x(a.file,JSON.stringify(a.param,null,2))}async function k(){await G(),await V(),O()}k();
|
package/dist/cli.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var u=(e=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(e,{get:(n,
|
|
1
|
+
var u=(e=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(e,{get:(n,o)=>(typeof require<"u"?require:n)[o]}):e)(function(e){if(typeof require<"u")return require.apply(this,arguments);throw Error('Dynamic require of "'+e+'" is not supported')});import E from"axios";import{execSync as T}from"child_process";import O from"os";import x from"fs";import m from"path";import P from"prompts";import{generateApi as k}from"swagger-typescript-api";var h=e=>/^(https?:\/\/|:?\/\/)/.test(e);import f from"fs";import A from"url";import v from"path";var c={param:process.argv.filter((e,n)=>n>1)};function g(e,n="value",o={}){Array.isArray(e)||(e=[e]);let s;return c.param.forEach((l,p)=>{if(e.includes(l))["value"].includes(n)?s=c.param[p+1]:["array"].includes(n)?s=Array.from({length:o.length??1}).map((J,q)=>c.param[p+q+1]):s=!["false"].includes(c.param[p+1]);else return}),s}function r(e){return g(e,"key")}function i(e){return g(e,"value")}function b(e,n={}){return g(e,"array",n)??[]}function d(e,n){let o=v.dirname(e);f.existsSync(o)||f.mkdirSync(o,{recursive:!0}),f.writeFileSync(e,n)}function j(){return typeof u<"u"&&typeof module<"u"?__filename:A.fileURLToPath(import.meta.url)}function S(){return typeof u<"u"&&typeof module<"u"?__dirname:v.dirname(j())}import{glob as D}from"glob";var a={files:[],param:{}},t={home:O.homedir(),enum:{}};function y(e){e&&console.log(e),process.exit()}async function F(){t.param={config:i(["--config","-c"]),configScan:r(["--config-scan","-cs"])??!0,configAll:r(["--config-all","-ca"]),quick:r(["--quick","-q"]),replaceTags:b(["--replace-tags","-rt"],{length:2}),convertGet:r(["--convert-get","-cg"]),removeParam:r(["--remove-param","-rp"]),removePrefixIndex:i(["--remove-prefix-index","-rpi"]),removeDts:r(["--remove-dts","-rd"]),removeEmptyComponents:r(["--remove-empty-components","-rec"])??!0,extractRequestQuery:i(["--extract-request-query","-erq"]),extractResponseRaw:r(["--extract-response-raw","-err"]),template:m.resolve(S(),"./templates")},t.config={templates:i(["--templates","-t"])??t.param.template,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(i("--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")??!0,defaultResponseType:i("--default-response")??"void",typePrefix:i("--type-prefix")??"",typeSuffix:i("--type-suffix")??"",cleanOutput:r("--clean-output"),...i("--api-class-name")?{apiClassName:i("--api-class-name")}:{},patch:r("--patch"),debug:r("--debug"),anotherArrayType:r("--another-array-type"),sortTypes:r("--sort-types"),extractEnums:r("--extract-enums")}}async function N(){t.param.config?a.files=t.param.config.split(","):t.param.configScan&&(a.files=D.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),a.files.length==0&&(a.files=["saconfig.json"]),!t.param.configAll&&a.files.length>1&&(a.files=(await P({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 C(){try{a.param={},a.param=JSON.parse(x.readFileSync(a.file,"utf-8"))}catch{}(!t.param.quick||[a.param.url,a.param.output,a.param.name].includes(void 0))&&(a.param=await P([{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"),t.docFile=m.resolve(`${a.param.output}/${a.param.name}-${new Date().getTime()}.json`)}async function R(e=0){if(a.file=a.files[e],await C(),h(a.param.url))await E.get(a.param.url).then(n=>w(n.data)).catch(n=>console.log("\u5931\u8D25\uFF1A",n));else try{await w(JSON.parse(x.readFileSync(m.resolve(a.param.url),"utf8")))}catch(n){console.log("\u5931\u8D25\uFF1A",n)}a.files[e+1]&&R(e+1)}async function w(e){if(typeof e?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(e.paths).forEach(n=>{Object.keys(n[1]).forEach(o=>{t.param.replaceTags.length&&(e.paths[n[0]][o].tags=e.paths[n[0]][o].tags?.map(p=>p.replace(new RegExp(`^${t.param.replaceTags[0]}$`,"g"),t.param.replaceTags[1]??"")));let s=`${n[0]}/${o}`;if(t.param.convertGet&&(s=s.replace(/([^\}]\/)get$/g,"$1query")),t.param.removeParam&&(s=s.replace(/\/\{.+?\}/g,"")),t.param.removePrefixIndex){let p=s.split("/");p=p.slice(0,1).concat(p.slice(Number(t.param.removePrefixIndex)+2)),s=p.join("/")}e.paths[n[0]][o].operationId=s;let l=s.split("/").slice(-1)[0];typeof t.enum[l]=="number"?t.enum[l]++:t.enum[l]=1})}),Object.entries(e.components).forEach(n=>{Object.keys(n[1]).forEach(o=>{t.param.removeEmptyComponents&&!Object.keys(e.components[n[0]][o]).length&&delete e.components[n[0]][o]})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(t.enum).map(n=>n.join("-"))),d(t.docFile,JSON.stringify(e)),console.log("\u6267\u884C\uFF1A",a.file),await k({fileName:`${a.param.name}.ts`,output:m.resolve(a.param.output),input:t.docFile,...t.config,param:t.param}),console.log("\u5B8C\u6210\uFF1A",m.resolve(a.param.output,`${a.param.name}${t.config.toJS?".js":".ts"}`)),t.config.toJS&&console.log("\u5B8C\u6210\uFF1A",m.resolve(a.param.output,`${a.param.name}.d.ts`)),x.unlinkSync(t.docFile),t.param.removeDts&&(console.log("\u6E05\u7406\uFF1A",m.resolve(a.param.output,`${a.param.name}.d.ts`)),T(`npx rimraf ${m.resolve(a.param.output,`${a.param.name}.d.ts`)}`,{cwd:t.home}).toString()),d(a.file,JSON.stringify(a.param,null,2))}async function $(){await F(),await N(),R()}$();
|
package/dist/index.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
var F=Object.create;var u=Object.defineProperty;var N=Object.getOwnPropertyDescriptor;var C=Object.getOwnPropertyNames;var J=Object.getPrototypeOf,_=Object.prototype.hasOwnProperty;var I=(e,r)=>{for(var o in r)u(e,o,{get:r[o],enumerable:!0})},S=(e,r,o,s)=>{if(r&&typeof r=="object"||typeof r=="function")for(let i of C(r))!_.call(e,i)&&i!==o&&u(e,i,{get:()=>r[i],enumerable:!(s=N(r,i))||s.enumerable});return e};var c=(e,r,o)=>(o=e!=null?F(J(e)):{},S(r||!e||!e.__esModule?u(o,"default",{value:e,enumerable:!0}):o,e)),L=e=>S(u({},"__esModule",{value:!0}),e);var M={};I(M,{generateApi:()=>H});module.exports=L(M);var j=c(require("axios"),1),A=require("child_process"),E=c(require("os"),1),d=c(require("fs"),1),l=c(require("path"),1),b=c(require("prompts"),1),T=require("swagger-typescript-api");var w=e=>/^(https?:\/\/|:?\/\/)/.test(e);var g=c(require("fs"),1),P=c(require("url"),1),y=c(require("path"),1),G={},f={param:process.argv.filter((e,r)=>r>1)};function x(e,r="value",o={}){Array.isArray(e)||(e=[e]);let s;return f.param.forEach((i,m)=>{if(e.includes(i))["value"].includes(r)?s=f.param[m+1]:["array"].includes(r)?s=Array.from({length:o.length??1}).map((Q,D)=>f.param[m+D+1]):s=!["false"].includes(f.param[m+1]);else return}),s}function t(e){return x(e,"key")}function p(e){return x(e,"value")}function R(e,r={}){return x(e,"array",r)??[]}function h(e,r){let o=y.default.dirname(e);g.default.existsSync(o)||g.default.mkdirSync(o,{recursive:!0}),g.default.writeFileSync(e,r)}function U(){return typeof require<"u"&&typeof module<"u"?__filename:P.default.fileURLToPath(G.url)}function $(){return typeof require<"u"&&typeof module<"u"?__dirname:y.default.dirname(U())}var O=require("glob"),a={files:[],param:{}},n={home:E.default.homedir(),enum:{}};function v(e){e&&console.log(e),process.exit()}async function V(){n.param={config:p(["--config","-c"]),configScan:t(["--config-scan","-cs"])??!0,configAll:t(["--config-all","-ca"]),quick:t(["--quick","-q"]),replaceTags:R(["--replace-tags","-rt"],{length:2}),convertGet:t(["--convert-get","-cg"]),removeParam:t(["--remove-param","-rp"]),removePrefixIndex:p(["--remove-prefix-index","-rpi"]),removeDts:t(["--remove-dts","-rd"]),removeEmptyComponents:t(["--remove-empty-components","-rec"])??!0,extractRequestQuery:p(["--extract-request-query","-erq"]),extractResponseRaw:t(["--extract-response-raw","-err"]),template:l.default.resolve($(),"./templates")},n.config={templates:p(["--templates","-t"])??n.param.template,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(p("--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")??!0,defaultResponseType:p("--default-response")??"void",typePrefix:p("--type-prefix")??"",typeSuffix:p("--type-suffix")??"",cleanOutput:t("--clean-output"),...p("--api-class-name")?{apiClassName:p("--api-class-name")}:{},patch:t("--patch"),debug:t("--debug"),anotherArrayType:t("--another-array-type"),sortTypes:t("--sort-types"),extractEnums:t("--extract-enums")}}async function B(){n.param.config?a.files=n.param.config.split(","):n.param.configScan&&(a.files=O.glob.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),a.files.length==0&&(a.files=["saconfig.json"]),!n.param.configAll&&a.files.length>1&&(a.files=(await(0,b.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:v("\u7ED3\u675F\uFF1A\u81F3\u5C11\u9009\u62E9\u4E00\u4E2A\u914D\u7F6E\u6587\u4EF6"))).files),a.files?.length>0||v("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA")}async function K(){try{a.param={},a.param=JSON.parse(d.default.readFileSync(a.file,"utf-8"))}catch{}(!n.param.quick||[a.param.url,a.param.output,a.param.name].includes(void 0))&&(a.param=await(0,b.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)&&v("\u7ED3\u675F\uFF1A\u624B\u52A8\u9000\u51FA"),n.docFile=l.default.resolve(`${a.param.output}/${a.param.name}-${new Date().getTime()}.json`)}async function k(e=0){if(a.file=a.files[e],await K(),w(a.param.url))await j.default.get(a.param.url).then(r=>q(r.data)).catch(r=>console.log("\u5931\u8D25\uFF1A",r));else try{await q(JSON.parse(d.default.readFileSync(l.default.resolve(a.param.url),"utf8")))}catch(r){console.log("\u5931\u8D25\uFF1A",r)}a.files[e+1]&&k(e+1)}async function q(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(o=>{n.param.replaceTags.length&&(e.paths[r[0]][o].tags=e.paths[r[0]][o].tags?.map(m=>m.replace(new RegExp(`^${n.param.replaceTags[0]}$`,"g"),n.param.replaceTags[1]??"")));let s=`${r[0]}/${o}`;if(n.param.convertGet&&(s=s.replace(/([^\}]\/)get$/g,"$1query")),n.param.removeParam&&(s=s.replace(/\/\{.+?\}/g,"")),n.param.removePrefixIndex){let m=s.split("/");m=m.slice(0,1).concat(m.slice(Number(n.param.removePrefixIndex)+2)),s=m.join("/")}e.paths[r[0]][o].operationId=s;let i=s.split("/").slice(-1)[0];typeof n.enum[i]=="number"?n.enum[i]++:n.enum[i]=1})}),Object.entries(e.components).forEach(r=>{Object.keys(r[1]).forEach(o=>{n.param.removeEmptyComponents&&!Object.keys(e.components[r[0]][o]).length&&delete e.components[r[0]][o]})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(n.enum).map(r=>r.join("-"))),h(n.docFile,JSON.stringify(e)),console.log("\u6267\u884C\uFF1A",a.file),await(0,T.generateApi)({fileName:`${a.param.name}.ts`,output:l.default.resolve(a.param.output),input:n.docFile,...n.config,param:n.param}),console.log("\u5B8C\u6210\uFF1A",l.default.resolve(a.param.output,`${a.param.name}${n.config.toJS?".js":".ts"}`)),n.config.toJS&&console.log("\u5B8C\u6210\uFF1A",l.default.resolve(a.param.output,`${a.param.name}.d.ts`)),d.default.unlinkSync(n.docFile),n.param.removeDts&&(console.log("\u6E05\u7406\uFF1A",l.default.resolve(a.param.output,`${a.param.name}.d.ts`)),(0,A.execSync)(`npx rimraf ${l.default.resolve(a.param.output,`${a.param.name}.d.ts`)}`,{cwd:n.home}).toString()),h(a.file,JSON.stringify(a.param,null,2))}async function H(){await V(),await B(),k()}0&&(module.exports={generateApi});
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var u=(e=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(e,{get:(n,
|
|
1
|
+
var u=(e=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(e,{get:(n,o)=>(typeof require<"u"?require:n)[o]}):e)(function(e){if(typeof require<"u")return require.apply(this,arguments);throw Error('Dynamic require of "'+e+'" is not supported')});import A from"axios";import{execSync as E}from"child_process";import T from"os";import x from"fs";import m from"path";import P from"prompts";import{generateApi as O}from"swagger-typescript-api";var h=e=>/^(https?:\/\/|:?\/\/)/.test(e);import f from"fs";import q from"url";import v from"path";var c={param:process.argv.filter((e,n)=>n>1)};function g(e,n="value",o={}){Array.isArray(e)||(e=[e]);let s;return c.param.forEach((l,p)=>{if(e.includes(l))["value"].includes(n)?s=c.param[p+1]:["array"].includes(n)?s=Array.from({length:o.length??1}).map((C,$)=>c.param[p+$+1]):s=!["false"].includes(c.param[p+1]);else return}),s}function r(e){return g(e,"key")}function i(e){return g(e,"value")}function b(e,n={}){return g(e,"array",n)??[]}function d(e,n){let o=v.dirname(e);f.existsSync(o)||f.mkdirSync(o,{recursive:!0}),f.writeFileSync(e,n)}function j(){return typeof u<"u"&&typeof module<"u"?__filename:q.fileURLToPath(import.meta.url)}function S(){return typeof u<"u"&&typeof module<"u"?__dirname:v.dirname(j())}import{glob as k}from"glob";var a={files:[],param:{}},t={home:T.homedir(),enum:{}};function y(e){e&&console.log(e),process.exit()}async function D(){t.param={config:i(["--config","-c"]),configScan:r(["--config-scan","-cs"])??!0,configAll:r(["--config-all","-ca"]),quick:r(["--quick","-q"]),replaceTags:b(["--replace-tags","-rt"],{length:2}),convertGet:r(["--convert-get","-cg"]),removeParam:r(["--remove-param","-rp"]),removePrefixIndex:i(["--remove-prefix-index","-rpi"]),removeDts:r(["--remove-dts","-rd"]),removeEmptyComponents:r(["--remove-empty-components","-rec"])??!0,extractRequestQuery:i(["--extract-request-query","-erq"]),extractResponseRaw:r(["--extract-response-raw","-err"]),template:m.resolve(S(),"./templates")},t.config={templates:i(["--templates","-t"])??t.param.template,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(i("--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")??!0,defaultResponseType:i("--default-response")??"void",typePrefix:i("--type-prefix")??"",typeSuffix:i("--type-suffix")??"",cleanOutput:r("--clean-output"),...i("--api-class-name")?{apiClassName:i("--api-class-name")}:{},patch:r("--patch"),debug:r("--debug"),anotherArrayType:r("--another-array-type"),sortTypes:r("--sort-types"),extractEnums:r("--extract-enums")}}async function F(){t.param.config?a.files=t.param.config.split(","):t.param.configScan&&(a.files=k.sync(["./**/saconfig*.json"],{ignore:"node_modules/**"})),a.files.length==0&&(a.files=["saconfig.json"]),!t.param.configAll&&a.files.length>1&&(a.files=(await P({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 N(){try{a.param={},a.param=JSON.parse(x.readFileSync(a.file,"utf-8"))}catch{}(!t.param.quick||[a.param.url,a.param.output,a.param.name].includes(void 0))&&(a.param=await P([{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"),t.docFile=m.resolve(`${a.param.output}/${a.param.name}-${new Date().getTime()}.json`)}async function R(e=0){if(a.file=a.files[e],await N(),h(a.param.url))await A.get(a.param.url).then(n=>w(n.data)).catch(n=>console.log("\u5931\u8D25\uFF1A",n));else try{await w(JSON.parse(x.readFileSync(m.resolve(a.param.url),"utf8")))}catch(n){console.log("\u5931\u8D25\uFF1A",n)}a.files[e+1]&&R(e+1)}async function w(e){if(typeof e?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(e.paths).forEach(n=>{Object.keys(n[1]).forEach(o=>{t.param.replaceTags.length&&(e.paths[n[0]][o].tags=e.paths[n[0]][o].tags?.map(p=>p.replace(new RegExp(`^${t.param.replaceTags[0]}$`,"g"),t.param.replaceTags[1]??"")));let s=`${n[0]}/${o}`;if(t.param.convertGet&&(s=s.replace(/([^\}]\/)get$/g,"$1query")),t.param.removeParam&&(s=s.replace(/\/\{.+?\}/g,"")),t.param.removePrefixIndex){let p=s.split("/");p=p.slice(0,1).concat(p.slice(Number(t.param.removePrefixIndex)+2)),s=p.join("/")}e.paths[n[0]][o].operationId=s;let l=s.split("/").slice(-1)[0];typeof t.enum[l]=="number"?t.enum[l]++:t.enum[l]=1})}),Object.entries(e.components).forEach(n=>{Object.keys(n[1]).forEach(o=>{t.param.removeEmptyComponents&&!Object.keys(e.components[n[0]][o]).length&&delete e.components[n[0]][o]})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(t.enum).map(n=>n.join("-"))),d(t.docFile,JSON.stringify(e)),console.log("\u6267\u884C\uFF1A",a.file),await O({fileName:`${a.param.name}.ts`,output:m.resolve(a.param.output),input:t.docFile,...t.config,param:t.param}),console.log("\u5B8C\u6210\uFF1A",m.resolve(a.param.output,`${a.param.name}${t.config.toJS?".js":".ts"}`)),t.config.toJS&&console.log("\u5B8C\u6210\uFF1A",m.resolve(a.param.output,`${a.param.name}.d.ts`)),x.unlinkSync(t.docFile),t.param.removeDts&&(console.log("\u6E05\u7406\uFF1A",m.resolve(a.param.output,`${a.param.name}.d.ts`)),E(`npx rimraf ${m.resolve(a.param.output,`${a.param.name}.d.ts`)}`,{cwd:t.home}).toString()),d(a.file,JSON.stringify(a.param,null,2))}async function ne(){await D(),await F(),R()}export{ne as generateApi};
|
|
@@ -1,32 +1,32 @@
|
|
|
1
|
-
<%
|
|
2
|
-
const { utils, config, routes, modelTypes } = it;
|
|
3
|
-
const { _, pascalCase } = utils;
|
|
4
|
-
const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
|
|
5
|
-
%>
|
|
6
|
-
|
|
7
|
-
<% if (dataContracts.length) { %>
|
|
8
|
-
import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
|
|
9
|
-
<% } %>
|
|
10
|
-
|
|
11
|
-
<%
|
|
12
|
-
/* TODO: outOfModule, combined should be attributes of route, which will allow to avoid duplication of code */
|
|
13
|
-
%>
|
|
14
|
-
|
|
15
|
-
<% if (routes.outOfModule) { %>
|
|
16
|
-
<% for (const { routes: outOfModuleRoutes = [] } of routes.outOfModule) { %>
|
|
17
|
-
<% for (const route of outOfModuleRoutes) { %>
|
|
18
|
-
<%~ includeFile('./route-type.ejs', { ...it, route }) %>
|
|
19
|
-
<% } %>
|
|
20
|
-
<% } %>
|
|
21
|
-
<% } %>
|
|
22
|
-
|
|
23
|
-
<% if (routes.combined) { %>
|
|
24
|
-
<% for (const { routes: combinedRoutes = [], moduleName } of routes.combined) { %>
|
|
25
|
-
export namespace <%~ pascalCase(moduleName) %> {
|
|
26
|
-
<% for (const route of combinedRoutes) { %>
|
|
27
|
-
<%~ includeFile('./route-type.ejs', { ...it, route }) %>
|
|
28
|
-
<% } %>
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
<% } %>
|
|
32
|
-
<% } %>
|
|
1
|
+
<%
|
|
2
|
+
const { utils, config, routes, modelTypes } = it;
|
|
3
|
+
const { _, pascalCase } = utils;
|
|
4
|
+
const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
|
|
5
|
+
%>
|
|
6
|
+
|
|
7
|
+
<% if (dataContracts.length) { %>
|
|
8
|
+
import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
|
|
9
|
+
<% } %>
|
|
10
|
+
|
|
11
|
+
<%
|
|
12
|
+
/* TODO: outOfModule, combined should be attributes of route, which will allow to avoid duplication of code */
|
|
13
|
+
%>
|
|
14
|
+
|
|
15
|
+
<% if (routes.outOfModule) { %>
|
|
16
|
+
<% for (const { routes: outOfModuleRoutes = [] } of routes.outOfModule) { %>
|
|
17
|
+
<% for (const route of outOfModuleRoutes) { %>
|
|
18
|
+
<%~ includeFile('./route-type.ejs', { ...it, route }) %>
|
|
19
|
+
<% } %>
|
|
20
|
+
<% } %>
|
|
21
|
+
<% } %>
|
|
22
|
+
|
|
23
|
+
<% if (routes.combined) { %>
|
|
24
|
+
<% for (const { routes: combinedRoutes = [], moduleName } of routes.combined) { %>
|
|
25
|
+
export namespace <%~ pascalCase(moduleName) %> {
|
|
26
|
+
<% for (const route of combinedRoutes) { %>
|
|
27
|
+
<%~ includeFile('./route-type.ejs', { ...it, route }) %>
|
|
28
|
+
<% } %>
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
<% } %>
|
|
32
|
+
<% } %>
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
<%
|
|
2
|
-
const { contract, utils } = it;
|
|
3
|
-
const { formatDescription, require, _ } = utils;
|
|
4
|
-
|
|
5
|
-
%>
|
|
6
|
-
<% if (contract.$content.length) { %>
|
|
7
|
-
export type <%~ contract.name %> = {
|
|
8
|
-
<% for (const field of contract.$content) { %>
|
|
9
|
-
<%~ includeFile('./object-field-jsdoc.ejs', { ...it, field }) %>
|
|
10
|
-
<%~ field.field %>;
|
|
11
|
-
<% } %>
|
|
12
|
-
}<%~ utils.isNeedToAddNull(contract) ? ' | null' : ''%>
|
|
13
|
-
<% } else { %>
|
|
14
|
-
export type <%~ contract.name %> = Record<string, any>;
|
|
15
|
-
<% } %>
|
|
1
|
+
<%
|
|
2
|
+
const { contract, utils } = it;
|
|
3
|
+
const { formatDescription, require, _ } = utils;
|
|
4
|
+
|
|
5
|
+
%>
|
|
6
|
+
<% if (contract.$content.length) { %>
|
|
7
|
+
export type <%~ contract.name %> = {
|
|
8
|
+
<% for (const field of contract.$content) { %>
|
|
9
|
+
<%~ includeFile('./object-field-jsdoc.ejs', { ...it, field }) %>
|
|
10
|
+
<%~ field.field %>;
|
|
11
|
+
<% } %>
|
|
12
|
+
}<%~ utils.isNeedToAddNull(contract) ? ' | null' : ''%>
|
|
13
|
+
<% } else { %>
|
|
14
|
+
export type <%~ contract.name %> = Record<string, any>;
|
|
15
|
+
<% } %>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fxri/swagger2api",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0",
|
|
4
4
|
"description": "基于 swagger-typescript-api,将 Swagger 文档自动转为 TypeScript 格式的 API 文件。",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": {
|
|
@@ -28,6 +28,7 @@
|
|
|
28
28
|
"swagger-typescript-api": "^13.2.15"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
|
+
"@fxri/toolkit": "^1.1.3",
|
|
31
32
|
"@types/node": "^20.19.21",
|
|
32
33
|
"@types/prompts": "^2.4.9",
|
|
33
34
|
"@typescript-eslint/eslint-plugin": "^6.21.0",
|
|
@@ -59,6 +60,10 @@
|
|
|
59
60
|
"build": "cross-env NODE_ENV=production tsup",
|
|
60
61
|
"build:debug": "cross-env NODE_ENV=development tsup --config tsup.dev.config.ts",
|
|
61
62
|
"release": "pnpm build && pnpm publish",
|
|
62
|
-
"api": "pnpm dev --axios --responses -q -rpi 0 -err"
|
|
63
|
+
"api": "pnpm dev --axios --responses -q -rpi 0 -err",
|
|
64
|
+
"tasks": "toolkit tasks",
|
|
65
|
+
"tasks:archive": "toolkit tasks archive",
|
|
66
|
+
"changeset": "toolkit changelog",
|
|
67
|
+
"version": "toolkit changelog version"
|
|
63
68
|
}
|
|
64
69
|
}
|