ol-base-components 2.2.0 → 2.2.2

package/README.md

@@ -59,6 +59,45 @@ import { swaggerUnload } from "ol-base-components";
 swaggerUnload()
 ```
 
+## API 脚本
+
+### 1. `api.js`
+
+`api.js` 脚本用于从指定的 Swagger URL 获取 API 数据，并生成相应的 API 模块文件。
+
+#### 使用方法
+
+```bash
+npx api http://192.168.xxx.xxx [outputPath]
+```
+
+- **参数**：
+  - `http://192.168.xxx.xxx` 是 Swagger API 的基础 URL。
+  - `[outputPath]` 是可选参数，指定生成的文件路径，默认为 `src/api/swagger.js`。
+- **作用**：该脚本会自动生成 Swagger 数据的 API 接口模块，并保存到指定的目录中，且包含JSDoc，方便查看接口入参及类型。
+
+#### 效果图
+
+![Local demo](./src/assets/api.png "Local demo")
+
+### 2. `run.js`
+
+`run.js` 脚本用于从指定的 Swagger URL 下载 Swagger JSON 文件，并生成相应的 API 模块文件。
+
+#### 使用方法
+
+```bash
+npx run http://192.168.xxx.xxx [outputPath]
+```
+
+- **参数**：
+  - `http://192.168.xxx.xxx` 是 Swagger API 的基础 URL。
+  - `[outputPath]` 是可选参数，指定生成的文件路径，默认为 `src/api/modules`。
+- **作用**：该脚本会从指定的 Swagger URL 下载 Swagger JSON 数据，并生成相应的 API 接口路径文件。
+
+#### 效果图
+
+![Local demo](./src/assets/run.png "Local demo")
 
 ## 组件示例
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ol-base-components",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "private": false,
   "main": "src/package/index.js",
   "bin": {
@@ -47,7 +47,7 @@
   "keywords": [
     "ol-base-components"
   ],
-  "description": "二次封装的通用组件库。table，form",
+  "description": "二次封装的通用组件库。table，form。核心解决前后端字段联调问题。",
   "browserslist": [
     "> 1%",
     "last 2 versions",

package/src/api/api.js

@@ -105,7 +105,7 @@ const generateApiModules = (swagger) => {
   tags.forEach((tag) => {
     apiModules[
       tag.name
-    ] = `import { get, post, put, del } from "@/api/request/sendRuest"\n`;
+    ] = `import { api } from "@/api/request/sendRuest"\n`;
   });
 
   for (const [url, methods] of Object.entries(paths)) {
@@ -188,8 +188,9 @@ const generateApiModules = (swagger) => {
             method
           )} = (${functionParams}) => {\n`;
 
-          functionDoc += ` return ${MethodEnum[method]}({\n`;
+          functionDoc += ` return api({\n`;
           functionDoc += `  url: \`${url.replace(/{/g, "${")}\`,\n`;
+          functionDoc += `  method: "${MethodEnum[method]}",\n`;
           if (hasQuery) functionDoc += `  params,\n`;
           if (hasBody) functionDoc += `  data: body,\n`;
           functionDoc += ` });\n`;