@fxri/swagger2api 1.0.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 ADDED
@@ -0,0 +1,5 @@
1
+ {
2
+ "url": "http://develop-daggoo-technology.daggoo-k8s.com/backend/pub/v3/api-docs",
3
+ "output": "./src/api",
4
+ "name": "index"
5
+ }
package/README.md ADDED
@@ -0,0 +1,82 @@
1
+ # @fxri/swagger2api
2
+
3
+ 基于 swagger-typescript-api,将 Swagger 文档自动转为 TypeScript 格式的 API 文件
4
+
5
+ ## ✨ 特性
6
+
7
+ - 🚀 **快速生成** - 从 Swagger JSON 快速生成 TypeScript 接口代码
8
+ - 📁 **特性区别** - 利用现有参数拼接了新的 operationId 字段,避免了重名接口会出现【_n】后缀的情况,
9
+ - 📝 **拼接规则** - 将接口地址与请求方法拼接作为唯一ID,将不带【{.+}】参数的【get】改为【query】作区分,然后移除【{.+}】参数,并移除地址的第一个参数
10
+ - 🔧 **CLI 工具** - 更多参数可查看 swagger-typescript-api 官方文档
11
+
12
+ ## 📦 安装
13
+
14
+ ```bash
15
+ # 全局安装
16
+ pnpm install -g @fxri/swagger2api
17
+
18
+ # 项目依赖
19
+ pnpm install @fxri/swagger2api
20
+ ```
21
+
22
+ ## 🚀 快速开始
23
+
24
+ ### 1. 生成接口代码
25
+
26
+ ```bash
27
+ npx @fxri/swagger2api
28
+ ```
29
+
30
+ ### 2. 配置文件说明
31
+
32
+ 工具在脚本执行目录生成配置文件,作为生成接口时的默认参数,生成代码结束后,如果参数有改动,则会更新配置文件:
33
+
34
+ ```json
35
+ {
36
+ "url": "https://example.com/v3/api-docs",
37
+ "output": "./src/api",
38
+ "name": "index"
39
+ }
40
+ ```
41
+
42
+ ## ⚙️ 配置选项
43
+
44
+ | 选项 | 类型 | 默认值 | 说明 |
45
+ |------|------|--------|------|
46
+ | `url` | string | - | Swagger JSON 文件路径或 URL |
47
+ | `output` | string | `'./src/api'` | 生成代码的输出目录 |
48
+ | `name` | string | `'index'` | 接口文件名称,后缀为ts |
49
+ | `config` | string | `'.swaggerrc'` | 配置文件 |
50
+
51
+ ## 🔧 CLI 命令
52
+
53
+ ```bash
54
+ # 生成接口代码
55
+ npx @fxri/swagger2api [--config <path>]
56
+ ```
57
+
58
+ ## 📝 PNPM 脚本
59
+
60
+ 在 `package.json` 中添加:
61
+
62
+ ```json
63
+ {
64
+ "scripts": {
65
+ "api": "@fxri/swagger2api",
66
+ }
67
+ }
68
+ ```
69
+
70
+ ## 🤝 贡献
71
+
72
+ 欢迎提交 Issue 和 Pull Request!
73
+
74
+ ## 📄 版权信息
75
+
76
+ 作者:唐启云 <tqy@fxri.net>
77
+
78
+ 版权:Copyright © 2025 方弦研究所. All rights reserved.
79
+
80
+ 网站:[方弦研究信息网](https://fxri.net:444/)
81
+
82
+ 协议:MIT License