浏览代码

chore: 完善 api_build 描述

许俊杰 3 年之前
父节点
当前提交
ff87c694a8
共有 2 个文件被更改,包括 15 次插入7 次删除
  1. 5 3
      Web/api_build/build.bat
  2. 10 4
      Web/api_build/readme.md

+ 5 - 3
Web/api_build/build.bat

@@ -6,11 +6,11 @@ set dir=%~dp0
 set apiServicesPath=%dir%..\src\api-services\
 
 if exist %apiServicesPath% (
-    echo 删除 api-services 文件夹
+    echo ================================ 删除目录 api-services ================================
     rd /s /q %apiServicesPath%
 )
 
-echo 开始生成 api-services ...
+echo ================================ 开始生成 api-services ================================
 
 java -jar %dir%swagger-codegen-cli.jar generate -i http://localhost:5005/swagger/All%%20Groups/swagger.json -l typescript-axios -o %apiServicesPath%
 
@@ -22,4 +22,6 @@ del /q %apiServicesPath%.swagger-codegen-ignore
 del /q %apiServicesPath%git_push.sh
 del /q %apiServicesPath%package.json
 del /q %apiServicesPath%README.md
-del /q %apiServicesPath%tsconfig.json
+del /q %apiServicesPath%tsconfig.json
+
+echo ================================ 生成结束 ================================

+ 10 - 4
Web/api_build/readme.md

@@ -2,13 +2,17 @@
 
 前端 API 请求代理,可以通过 swagger.json 生成 typescript-axios 客户端的方式生成,然后拷贝到 src/api-services 文件夹
 
-## 手动在线生成
+## 手动生成
 
-- 参照 https://furion.baiqian.ltd/docs/clientapi#563-%E7%94%9F%E6%88%90%E5%AE%A2%E6%88%B7%E7%AB%AF%E8%AF%B7%E6%B1%82%E4%BB%A3%E7%A0%81
+- 打开 https://editor.swagger.io/
+- 拷贝 swagger.json 内容到网站左侧
+- 选择顶部【Generate Client】-【typescript-axios】生成客户端并下载
+- 将下载的 zip 内容拷贝到 src/api-services 文件夹中替换
+  > 详情参照 https://furion.baiqian.ltd/docs/clientapi#563-%E7%94%9F%E6%88%90%E5%AE%A2%E6%88%B7%E7%AB%AF%E8%AF%B7%E6%B1%82%E4%BB%A3%E7%A0%81
 
 ## 脚本一键生成
 
-通过 Swagger Codegen 生成 typescript-axios 客户端后,直接拷贝到 src/api-services 文件夹中
+Swagger Codegen 读取 swagger.json 生成 typescript-axios 客户端后,直接拷贝到 src/api-services 文件夹中
 
 > Swagger Codegen 可以通过为任何 API 生成服务端代码和客户端代码的方式来简化 OpenAPI 的构建过程,因此,项目开发团队可以更好地关注 API 的实现和应用
 > Github:https://github.com/swagger-api/swagger-codegen
@@ -31,4 +35,6 @@
 
 - 启动 API 端服务,确保 http://localhost:5005/ 可以访问
 - Windows:运行 `build.bat`
-- Linux / Mac:运行`./build.sh`
+- Linux / Mac:运行`./build.sh`
+
+> http://localhost:5005/ 为默认的 API 地址,如果要连接其他地址,请自行调整对应脚本