@fxri/swagger2api 1.0.15 → 1.1.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/.swaggerrc +1 -1
- package/README.md +36 -20
- package/dist/bin/index.cjs +1 -0
- package/dist/bin/index.d.cts +2 -0
- package/dist/bin/index.d.ts +2 -0
- package/dist/bin/index.js +1 -0
- package/dist/index.cjs +1 -0
- package/dist/index.d.cts +4 -0
- package/dist/index.d.ts +4 -1
- package/dist/index.js +1 -115
- package/package.json +16 -15
- package/dist/api/ParsonnelAdmin.d.ts +0 -8674
- package/dist/api/ParsonnelAdmin.js +0 -4105
- package/dist/api/api.d.ts +0 -1
- package/dist/api/api.js +0 -3
- package/dist/api/index.d.ts +0 -1673
- package/dist/api/index.js +0 -665
- package/dist/api/kjt.d.ts +0 -1673
- package/dist/api/kjt.js +0 -665
- package/dist/api/kqtmg.d.ts +0 -56119
- package/dist/api/kqtmg.js +0 -39441
- package/dist/utils/common.d.ts +0 -21
- package/dist/utils/common.js +0 -75
- package/dist/utils/index.d.ts +0 -2
- package/dist/utils/index.js +0 -4
- package/dist/utils/method.d.ts +0 -2
- package/dist/utils/method.js +0 -7
package/.swaggerrc
CHANGED
package/README.md
CHANGED
|
@@ -12,14 +12,50 @@
|
|
|
12
12
|
|
|
13
13
|
## 📦 安装
|
|
14
14
|
|
|
15
|
+
pnpm
|
|
16
|
+
|
|
15
17
|
```bash
|
|
16
18
|
# 全局安装
|
|
17
19
|
pnpm install -g @fxri/swagger2api
|
|
20
|
+
```
|
|
18
21
|
|
|
22
|
+
```bash
|
|
19
23
|
# 项目依赖
|
|
20
24
|
pnpm install @fxri/swagger2api
|
|
21
25
|
```
|
|
22
26
|
|
|
27
|
+
yarn
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# 全局安装
|
|
31
|
+
yarn global add @fxri/swagger2api
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
# 项目依赖
|
|
36
|
+
yarn add @fxri/swagger2api
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## 📝 PNPM 脚本
|
|
40
|
+
|
|
41
|
+
在 `package.json` 中添加:
|
|
42
|
+
|
|
43
|
+
生成 axios http 客户端,生成有关请求响应的附加信息,移除第一个前缀索引,使用快速模式
|
|
44
|
+
|
|
45
|
+
```json
|
|
46
|
+
{
|
|
47
|
+
"scripts": {
|
|
48
|
+
"api": "swagger2api --axios --responses --remove-prefix-index 0 --quick"
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
{
|
|
53
|
+
"scripts": {
|
|
54
|
+
"api": "npx @fxri/swagger2api --axios --responses --remove-prefix-index 0 --quick"
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
23
59
|
## 🚀 快速开始
|
|
24
60
|
|
|
25
61
|
### 1. 生成接口代码
|
|
@@ -125,26 +161,6 @@ npx swagger2api [--remove-d.ts,-rd] [--remove-d.ts,-rd <boolean>]
|
|
|
125
161
|
npx @fxri/swagger2api [--remove-d.ts,-rd] [--remove-d.ts,-rd <boolean>]
|
|
126
162
|
```
|
|
127
163
|
|
|
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
|
-
}
|
|
140
|
-
|
|
141
|
-
{
|
|
142
|
-
"scripts": {
|
|
143
|
-
"api": "npx @fxri/swagger2api --axios --responses --remove-prefix-index 0 --quick"
|
|
144
|
-
}
|
|
145
|
-
}
|
|
146
|
-
```
|
|
147
|
-
|
|
148
164
|
## 🤝 贡献
|
|
149
165
|
|
|
150
166
|
欢迎提交 Issue 和 Pull Request!
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
var k=Object.create;var x=Object.defineProperty;var A=Object.getOwnPropertyDescriptor;var P=Object.getOwnPropertyNames;var T=Object.getPrototypeOf,q=Object.prototype.hasOwnProperty;var E=(e,r,s,o)=>{if(r&&typeof r=="object"||typeof r=="function")for(let n of P(r))!q.call(e,n)&&n!==s&&x(e,n,{get:()=>r[n],enumerable:!(o=A(r,n))||o.enumerable});return e};var u=(e,r,s)=>(s=e!=null?k(T(e)):{},E(r||!e||!e.__esModule?x(s,"default",{value:e,enumerable:!0}):s,e));var w=u(require("axios"),1),O=require("child_process"),j=u(require("os"),1),d=u(require("fs"),1),c=u(require("path"),1),N=u(require("prompts"),1),R=require("swagger-typescript-api");var h=e=>/^(https?:\/\/|:?\/\/)/.test(e);var g=u(require("fs"),1),b=u(require("path"),1),l={param:process.argv.filter((e,r)=>r>1),used:{}};function v(e,r=!0,s=!0){Array.isArray(e)||(e=[e]);let o;return l.param.forEach((n,i)=>{if(e.includes(n))r?(o=l.param[i+1],s&&Object.assign(l.used,{[i+1]:!0})):["true","false"].includes(l.param[i+1])?(o=l.param[i+1].toLowerCase()=="true",s&&Object.assign(l.used,{[i+1]:!0})):o=!0;else return;s&&Object.assign(l.used,{[i]:!0})}),o}function t(e,r=!0){return v(e,!1,r)}function p(e,r=!0){return v(e,!0,r)}function y(e,r){let s=b.default.dirname(e);g.default.existsSync(s)||g.default.mkdirSync(s,{recursive:!0}),g.default.writeFileSync(e,r)}var a,m;async function D(){a={file:c.default.resolve(p(["--config","-c"])??".swaggerrc"),param:{}};try{a.param=JSON.parse(d.default.readFileSync(a.file,"utf-8"))}catch{}(!t(["--quick","-q"])||[a.param.url,a.param.output,a.param.name].includes(void 0))&&(a.param=await(0,N.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)&&(console.log("\u5931\u8D25\uFF1A\u624B\u52A8\u9000\u51FA"),process.exit()),m={home:j.default.homedir(),file:c.default.resolve(`${a.param.output}/${a.param.name}-${new Date().getTime()}.json`),enum:{}}}function F(e=a.param.url){if(h(e))w.default.get(e).then(r=>S(r.data)).catch(r=>console.log("\u5931\u8D25\uFF1A",r));else try{S(JSON.parse(d.default.readFileSync(c.default.resolve(e),"utf8")))}catch(r){console.log("\u5931\u8D25\uFF1A",r)}}async function S(e){if(typeof e?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(e.paths).forEach(s=>{Object.keys(s[1]).forEach(o=>{let n=`${s[0]}/${o}`;if(t(["--convert-get","-cg"])&&(n=n.replace(/([^\}]\/)get$/g,"$1query")),t(["--remove-param","-rp"])&&(n=n.replace(/\/\{.+?\}/g,"")),p(["--remove-prefix-index","-rpi"])){let f=n.split("/");f=f.slice(0,1).concat(f.slice(Number(p(["--remove-prefix-index","-rpi"]))+2)),n=f.join("/")}e.paths[s[0]][o].operationId=n;let i=n.split("/").slice(-1)[0];typeof m.enum[i]=="number"?m.enum[i]++:m.enum[i]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(m.enum).map(s=>s.join("-"))),y(m.file,JSON.stringify(e));let r=t(["--remove-d.ts","-rd"]);console.log("\u6267\u884C\uFF1A"),await(0,R.generateApi)({fileName:`${a.param.name}.ts`,output:c.default.resolve(a.param.output),input:m.file,templates:p(["--templates","-t"]),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"),defaultResponseType:p("--default-response")??"void",typePrefix:p("--type-prefix"),typeSuffix:p("--type-suffix"),cleanOutput:t("--clean-output"),apiClassName:p("--api-class-name "),patch:t("--patch"),debug:t("--debug"),anotherArrayType:t("--another-array-type"),sortTypes:t("--sort-types"),extractEnums:t("--extract-enums")}),d.default.unlinkSync(m.file),r&&(console.log("\u6E05\u7406\uFF1A",c.default.resolve(a.param.output,`${a.param.name}.d.ts`)),(0,O.execSync)(`npx rimraf ${c.default.resolve(a.param.output,`${a.param.name}.d.ts`)}`,{cwd:m.home}).toString()),y(a.file,JSON.stringify(a.param,null,4))}async function $(){await D(),F()}$();
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import S from"axios";import{execSync as w}from"child_process";import O from"os";import d from"fs";import l from"path";import j from"prompts";import{generateApi as N}from"swagger-typescript-api";var y=t=>/^(https?:\/\/|:?\/\/)/.test(t);import f from"fs";import v from"path";var u={param:process.argv.filter((t,a)=>a>1),used:{}};function x(t,a=!0,s=!0){Array.isArray(t)||(t=[t]);let m;return u.param.forEach((n,o)=>{if(t.includes(n))a?(m=u.param[o+1],s&&Object.assign(u.used,{[o+1]:!0})):["true","false"].includes(u.param[o+1])?(m=u.param[o+1].toLowerCase()=="true",s&&Object.assign(u.used,{[o+1]:!0})):m=!0;else return;s&&Object.assign(u.used,{[o]:!0})}),m}function e(t,a=!0){return x(t,!1,a)}function i(t,a=!0){return x(t,!0,a)}function g(t,a){let s=v.dirname(t);f.existsSync(s)||f.mkdirSync(s,{recursive:!0}),f.writeFileSync(t,a)}var r,p;async function R(){r={file:l.resolve(i(["--config","-c"])??".swaggerrc"),param:{}};try{r.param=JSON.parse(d.readFileSync(r.file,"utf-8"))}catch{}(!e(["--quick","-q"])||[r.param.url,r.param.output,r.param.name].includes(void 0))&&(r.param=await j([{name:"url",type:"text",message:"Swagger docs \u5730\u5740:",initial:r.param.url??"https://example.com/v3/api-docs"},{name:"output",type:"text",message:"\u8F93\u51FA\u5730\u5740:",initial:r.param.output??"./src/api"},{name:"name",type:"text",message:"\u6587\u4EF6\u540D:",initial:r.param.name??"index"}])),[r.param.url,r.param.output,r.param.name].includes(void 0)&&(console.log("\u5931\u8D25\uFF1A\u624B\u52A8\u9000\u51FA"),process.exit()),p={home:O.homedir(),file:l.resolve(`${r.param.output}/${r.param.name}-${new Date().getTime()}.json`),enum:{}}}function $(t=r.param.url){if(y(t))S.get(t).then(a=>h(a.data)).catch(a=>console.log("\u5931\u8D25\uFF1A",a));else try{h(JSON.parse(d.readFileSync(l.resolve(t),"utf8")))}catch(a){console.log("\u5931\u8D25\uFF1A",a)}}async function h(t){if(typeof t?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(t.paths).forEach(s=>{Object.keys(s[1]).forEach(m=>{let n=`${s[0]}/${m}`;if(e(["--convert-get","-cg"])&&(n=n.replace(/([^\}]\/)get$/g,"$1query")),e(["--remove-param","-rp"])&&(n=n.replace(/\/\{.+?\}/g,"")),i(["--remove-prefix-index","-rpi"])){let c=n.split("/");c=c.slice(0,1).concat(c.slice(Number(i(["--remove-prefix-index","-rpi"]))+2)),n=c.join("/")}t.paths[s[0]][m].operationId=n;let o=n.split("/").slice(-1)[0];typeof p.enum[o]=="number"?p.enum[o]++:p.enum[o]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(p.enum).map(s=>s.join("-"))),g(p.file,JSON.stringify(t));let a=e(["--remove-d.ts","-rd"]);console.log("\u6267\u884C\uFF1A"),await N({fileName:`${r.param.name}.ts`,output:l.resolve(r.param.output),input:p.file,templates:i(["--templates","-t"]),defaultResponseAsSuccess:e(["--default-as-success","-d"]),generateResponses:e(["--responses","-r"]),generateUnionEnums:e("--union-enums"),addReadonly:e("--add-readonly"),generateRouteTypes:e("--route-types"),generateClient:e("--no-client"),enumNamesAsValues:e("--enum-names-as-values"),extractRequestParams:e("--extract-request-params"),extractRequestBody:e("--extract-request-body"),extractResponseBody:e("--extract-response-body"),extractResponseError:e("--extract-response-error"),modular:e("--modular"),toJS:e("--js"),moduleNameIndex:Number(i("--module-name-index")??0),moduleNameFirstTag:e("--module-name-first-tag"),httpClientType:e("--axios")?"axios":"fetch",unwrapResponseData:e("--unwrap-response-data"),disableThrowOnError:e("--disable-throw-on-error"),singleHttpClient:e("--single-http-client"),silent:e("--silent"),defaultResponseType:i("--default-response")??"void",typePrefix:i("--type-prefix"),typeSuffix:i("--type-suffix"),cleanOutput:e("--clean-output"),apiClassName:i("--api-class-name "),patch:e("--patch"),debug:e("--debug"),anotherArrayType:e("--another-array-type"),sortTypes:e("--sort-types"),extractEnums:e("--extract-enums")}),d.unlinkSync(p.file),a&&(console.log("\u6E05\u7406\uFF1A",l.resolve(r.param.output,`${r.param.name}.d.ts`)),w(`npx rimraf ${l.resolve(r.param.output,`${r.param.name}.d.ts`)}`,{cwd:p.home}).toString()),g(r.file,JSON.stringify(r.param,null,4))}async function b(){await R(),$()}b();
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
var k=Object.create;var g=Object.defineProperty;var P=Object.getOwnPropertyDescriptor;var T=Object.getOwnPropertyNames;var q=Object.getPrototypeOf,A=Object.prototype.hasOwnProperty;var E=(e,r)=>{for(var s in r)g(e,s,{get:r[s],enumerable:!0})},h=(e,r,s,o)=>{if(r&&typeof r=="object"||typeof r=="function")for(let n of T(r))!A.call(e,n)&&n!==s&&g(e,n,{get:()=>r[n],enumerable:!(o=P(r,n))||o.enumerable});return e};var u=(e,r,s)=>(s=e!=null?k(q(e)):{},h(r||!e||!e.__esModule?g(s,"default",{value:e,enumerable:!0}):s,e)),D=e=>h(g({},"__esModule",{value:!0}),e);var I={};E(I,{generateApi:()=>J});module.exports=D(I);var O=u(require("axios"),1),j=require("child_process"),N=u(require("os"),1),y=u(require("fs"),1),c=u(require("path"),1),R=u(require("prompts"),1),$=require("swagger-typescript-api");var b=e=>/^(https?:\/\/|:?\/\/)/.test(e);var d=u(require("fs"),1),v=u(require("path"),1),l={param:process.argv.filter((e,r)=>r>1),used:{}};function S(e,r=!0,s=!0){Array.isArray(e)||(e=[e]);let o;return l.param.forEach((n,i)=>{if(e.includes(n))r?(o=l.param[i+1],s&&Object.assign(l.used,{[i+1]:!0})):["true","false"].includes(l.param[i+1])?(o=l.param[i+1].toLowerCase()=="true",s&&Object.assign(l.used,{[i+1]:!0})):o=!0;else return;s&&Object.assign(l.used,{[i]:!0})}),o}function t(e,r=!0){return S(e,!1,r)}function p(e,r=!0){return S(e,!0,r)}function x(e,r){let s=v.default.dirname(e);d.default.existsSync(s)||d.default.mkdirSync(s,{recursive:!0}),d.default.writeFileSync(e,r)}var a,m;async function F(){a={file:c.default.resolve(p(["--config","-c"])??".swaggerrc"),param:{}};try{a.param=JSON.parse(y.default.readFileSync(a.file,"utf-8"))}catch{}(!t(["--quick","-q"])||[a.param.url,a.param.output,a.param.name].includes(void 0))&&(a.param=await(0,R.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)&&(console.log("\u5931\u8D25\uFF1A\u624B\u52A8\u9000\u51FA"),process.exit()),m={home:N.default.homedir(),file:c.default.resolve(`${a.param.output}/${a.param.name}-${new Date().getTime()}.json`),enum:{}}}function C(e=a.param.url){if(b(e))O.default.get(e).then(r=>w(r.data)).catch(r=>console.log("\u5931\u8D25\uFF1A",r));else try{w(JSON.parse(y.default.readFileSync(c.default.resolve(e),"utf8")))}catch(r){console.log("\u5931\u8D25\uFF1A",r)}}async function w(e){if(typeof e?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(e.paths).forEach(s=>{Object.keys(s[1]).forEach(o=>{let n=`${s[0]}/${o}`;if(t(["--convert-get","-cg"])&&(n=n.replace(/([^\}]\/)get$/g,"$1query")),t(["--remove-param","-rp"])&&(n=n.replace(/\/\{.+?\}/g,"")),p(["--remove-prefix-index","-rpi"])){let f=n.split("/");f=f.slice(0,1).concat(f.slice(Number(p(["--remove-prefix-index","-rpi"]))+2)),n=f.join("/")}e.paths[s[0]][o].operationId=n;let i=n.split("/").slice(-1)[0];typeof m.enum[i]=="number"?m.enum[i]++:m.enum[i]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(m.enum).map(s=>s.join("-"))),x(m.file,JSON.stringify(e));let r=t(["--remove-d.ts","-rd"]);console.log("\u6267\u884C\uFF1A"),await(0,$.generateApi)({fileName:`${a.param.name}.ts`,output:c.default.resolve(a.param.output),input:m.file,templates:p(["--templates","-t"]),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"),defaultResponseType:p("--default-response")??"void",typePrefix:p("--type-prefix"),typeSuffix:p("--type-suffix"),cleanOutput:t("--clean-output"),apiClassName:p("--api-class-name "),patch:t("--patch"),debug:t("--debug"),anotherArrayType:t("--another-array-type"),sortTypes:t("--sort-types"),extractEnums:t("--extract-enums")}),y.default.unlinkSync(m.file),r&&(console.log("\u6E05\u7406\uFF1A",c.default.resolve(a.param.output,`${a.param.name}.d.ts`)),(0,j.execSync)(`npx rimraf ${c.default.resolve(a.param.output,`${a.param.name}.d.ts`)}`,{cwd:m.home}).toString()),x(a.file,JSON.stringify(a.param,null,4))}async function J(){await F(),C()}0&&(module.exports={generateApi});
|
package/dist/index.d.cts
ADDED
package/dist/index.d.ts
CHANGED
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 v from"axios";import{execSync as S}from"child_process";import w from"os";import d from"fs";import l from"path";import O from"prompts";import{generateApi as j}from"swagger-typescript-api";var y=t=>/^(https?:\/\/|:?\/\/)/.test(t);import f from"fs";import b from"path";var u={param:process.argv.filter((t,a)=>a>1),used:{}};function x(t,a=!0,s=!0){Array.isArray(t)||(t=[t]);let m;return u.param.forEach((n,o)=>{if(t.includes(n))a?(m=u.param[o+1],s&&Object.assign(u.used,{[o+1]:!0})):["true","false"].includes(u.param[o+1])?(m=u.param[o+1].toLowerCase()=="true",s&&Object.assign(u.used,{[o+1]:!0})):m=!0;else return;s&&Object.assign(u.used,{[o]:!0})}),m}function e(t,a=!0){return x(t,!1,a)}function i(t,a=!0){return x(t,!0,a)}function g(t,a){let s=b.dirname(t);f.existsSync(s)||f.mkdirSync(s,{recursive:!0}),f.writeFileSync(t,a)}var r,p;async function N(){r={file:l.resolve(i(["--config","-c"])??".swaggerrc"),param:{}};try{r.param=JSON.parse(d.readFileSync(r.file,"utf-8"))}catch{}(!e(["--quick","-q"])||[r.param.url,r.param.output,r.param.name].includes(void 0))&&(r.param=await O([{name:"url",type:"text",message:"Swagger docs \u5730\u5740:",initial:r.param.url??"https://example.com/v3/api-docs"},{name:"output",type:"text",message:"\u8F93\u51FA\u5730\u5740:",initial:r.param.output??"./src/api"},{name:"name",type:"text",message:"\u6587\u4EF6\u540D:",initial:r.param.name??"index"}])),[r.param.url,r.param.output,r.param.name].includes(void 0)&&(console.log("\u5931\u8D25\uFF1A\u624B\u52A8\u9000\u51FA"),process.exit()),p={home:w.homedir(),file:l.resolve(`${r.param.output}/${r.param.name}-${new Date().getTime()}.json`),enum:{}}}function R(t=r.param.url){if(y(t))v.get(t).then(a=>h(a.data)).catch(a=>console.log("\u5931\u8D25\uFF1A",a));else try{h(JSON.parse(d.readFileSync(l.resolve(t),"utf8")))}catch(a){console.log("\u5931\u8D25\uFF1A",a)}}async function h(t){if(typeof t?.paths!="object")return console.log("\u5931\u8D25\uFF1A\u7F3A\u5C11paths\u5B57\u6BB5");Object.entries(t.paths).forEach(s=>{Object.keys(s[1]).forEach(m=>{let n=`${s[0]}/${m}`;if(e(["--convert-get","-cg"])&&(n=n.replace(/([^\}]\/)get$/g,"$1query")),e(["--remove-param","-rp"])&&(n=n.replace(/\/\{.+?\}/g,"")),i(["--remove-prefix-index","-rpi"])){let c=n.split("/");c=c.slice(0,1).concat(c.slice(Number(i(["--remove-prefix-index","-rpi"]))+2)),n=c.join("/")}t.paths[s[0]][m].operationId=n;let o=n.split("/").slice(-1)[0];typeof p.enum[o]=="number"?p.enum[o]++:p.enum[o]=1})}),console.log("\u5C31\u7EEA\uFF1A",...Object.entries(p.enum).map(s=>s.join("-"))),g(p.file,JSON.stringify(t));let a=e(["--remove-d.ts","-rd"]);console.log("\u6267\u884C\uFF1A"),await j({fileName:`${r.param.name}.ts`,output:l.resolve(r.param.output),input:p.file,templates:i(["--templates","-t"]),defaultResponseAsSuccess:e(["--default-as-success","-d"]),generateResponses:e(["--responses","-r"]),generateUnionEnums:e("--union-enums"),addReadonly:e("--add-readonly"),generateRouteTypes:e("--route-types"),generateClient:e("--no-client"),enumNamesAsValues:e("--enum-names-as-values"),extractRequestParams:e("--extract-request-params"),extractRequestBody:e("--extract-request-body"),extractResponseBody:e("--extract-response-body"),extractResponseError:e("--extract-response-error"),modular:e("--modular"),toJS:e("--js"),moduleNameIndex:Number(i("--module-name-index")??0),moduleNameFirstTag:e("--module-name-first-tag"),httpClientType:e("--axios")?"axios":"fetch",unwrapResponseData:e("--unwrap-response-data"),disableThrowOnError:e("--disable-throw-on-error"),singleHttpClient:e("--single-http-client"),silent:e("--silent"),defaultResponseType:i("--default-response")??"void",typePrefix:i("--type-prefix"),typeSuffix:i("--type-suffix"),cleanOutput:e("--clean-output"),apiClassName:i("--api-class-name "),patch:e("--patch"),debug:e("--debug"),anotherArrayType:e("--another-array-type"),sortTypes:e("--sort-types"),extractEnums:e("--extract-enums")}),d.unlinkSync(p.file),a&&(console.log("\u6E05\u7406\uFF1A",l.resolve(r.param.output,`${r.param.name}.d.ts`)),S(`npx rimraf ${l.resolve(r.param.output,`${r.param.name}.d.ts`)}`,{cwd:p.home}).toString()),g(r.file,JSON.stringify(r.param,null,4))}async function B(){await N(),R()}export{B as generateApi};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fxri/swagger2api",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "基于 swagger-typescript-api,将 Swagger 文档自动转为 TypeScript 格式的 API 文件。",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": {
|
|
@@ -10,9 +10,7 @@
|
|
|
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",
|
|
@@ -23,19 +21,22 @@
|
|
|
23
21
|
"dependencies": {
|
|
24
22
|
"axios": "^1.12.2",
|
|
25
23
|
"prompts": "^2.4.2",
|
|
26
|
-
"swagger-typescript-api": "^13.2.
|
|
24
|
+
"swagger-typescript-api": "^13.2.15"
|
|
27
25
|
},
|
|
28
26
|
"devDependencies": {
|
|
29
|
-
"@types/node": "^24.
|
|
27
|
+
"@types/node": "^24.7.1",
|
|
30
28
|
"@types/prompts": "^2.4.9",
|
|
31
|
-
"@typescript-eslint/eslint-plugin": "^6.
|
|
32
|
-
"@typescript-eslint/parser": "^6.
|
|
33
|
-
"eslint": "^8.
|
|
34
|
-
"eslint-config-prettier": "^9.
|
|
35
|
-
"eslint-plugin-vue": "^9.
|
|
36
|
-
"
|
|
29
|
+
"@typescript-eslint/eslint-plugin": "^6.21.0",
|
|
30
|
+
"@typescript-eslint/parser": "^6.21.0",
|
|
31
|
+
"eslint": "^8.57.1",
|
|
32
|
+
"eslint-config-prettier": "^9.1.2",
|
|
33
|
+
"eslint-plugin-vue": "^9.33.0",
|
|
34
|
+
"tsup": "^8.5.0",
|
|
37
35
|
"typescript": "^5.9.3"
|
|
38
36
|
},
|
|
37
|
+
"engines": {
|
|
38
|
+
"node": ">=20"
|
|
39
|
+
},
|
|
39
40
|
"publishConfig": {
|
|
40
41
|
"registry": "https://registry.npmjs.org/"
|
|
41
42
|
},
|
|
@@ -48,9 +49,9 @@
|
|
|
48
49
|
"url": "https://github.com/fxri-net/swagger2api/issues"
|
|
49
50
|
},
|
|
50
51
|
"scripts": {
|
|
51
|
-
"dev": "pnpm build && node ./dist/index.js",
|
|
52
|
-
"
|
|
53
|
-
"build": "
|
|
52
|
+
"dev": "pnpm build:debug && node ./dist/bin/index.js",
|
|
53
|
+
"build": "NODE_ENV=production tsup",
|
|
54
|
+
"build:debug": "NODE_ENV=development tsup",
|
|
54
55
|
"release": "pnpm build && pnpm publish",
|
|
55
56
|
"api": "pnpm dev --axios --responses --remove-prefix-index 0"
|
|
56
57
|
}
|