czh-api 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 所有重要的版本更新都会记录在此文件中。
 
+## [1.0.2] - 2025-12-25
+
+### 新增
+- 添加 `includePaths` 配置项，支持白名单过滤 API 路径
+- 如果配置了 `includePaths`，则只同步以这些前缀开头的 API
+
 ## [1.0.1] - 2025-12-25
 
 ### 新增

package/README.md

@@ -49,6 +49,10 @@ npm install -g czh-api
   "excludePaths": [
     "/sys/log",
     "/tool/gen"
+  ],
+  "includePaths": [
+    "/sys/user",
+    "/sys/role"
   ]
 }
 ```
@@ -62,6 +66,7 @@ npm install -g czh-api
 | `templates`      | `string`   | 否       | 指向您的自定义模板目录的路径。默认为 `init` 命令生成的目录。             |
 | `customImports`  | `string[]` | 否       | 一个自定义导入语句的数组，会被添加到每个生成的 API 文件的顶部。         |
 | `excludePaths`   | `string[]` | 否       | 一个 URL 路径前缀的数组。任何以此数组中前缀开头的 API 都将被忽略。     |
+| `includePaths`   | `string[]` | 否       | 一个 URL 路径前缀的数组。如果配置了此项，则只同步以这些前缀开头的 API。 |
 
 ## 📝 模板配置
 

package/dist/commands/build.js

@@ -18,7 +18,7 @@ exports.handleBuild = void 0;
  * @Author: czh
  * @Date: 2025-07-02 10:39:30
  * @LastEditors: Czh
- * @LastEditTime: 2025-07-02 11:47:00
+ * @LastEditTime: 2025-12-25 12:40:34
  */
 const chalk_1 = __importDefault(require("chalk"));
 const path_1 = __importDefault(require("path"));
@@ -45,7 +45,7 @@ const handleBuild = () => __awaiter(void 0, void 0, void 0, function* () {
         const api = yield SwaggerParser.bundle(response.data);
         console.log(chalk_1.default.green('Swagger document fetched and bundled successfully.'));
         // Process the API document
-        const modules = (0, parser_1.processApi)(api, config.excludePaths || []);
+        const modules = (0, parser_1.processApi)(api, config.excludePaths || [], config.includePaths || []);
         console.log(chalk_1.default.blue('API processed into modules.'));
         // Clean output directory
         const outputDir = path_1.default.join(process.cwd(), config.outputDir);

package/dist/commands/init.js

@@ -18,7 +18,7 @@ exports.handleInit = void 0;
  * @Author: czh
  * @Date: 2025-07-02 10:39:17
  * @LastEditors: Czh
- * @LastEditTime: 2025-07-02 11:45:10
+ * @LastEditTime: 2025-12-25 12:51:48
  */
 const chalk_1 = __importDefault(require("chalk"));
 const promises_1 = __importDefault(require("fs/promises"));
@@ -28,7 +28,8 @@ const defaultConfig = {
     outputDir: './src/api',
     templates: './czh-api-template',
     customImports: ['import http from "@/utils/http";'],
-    excludePaths: []
+    excludePaths: [],
+    includePaths: []
 };
 const templates = ['api.hbs', 'index.hbs', 'types.hbs'];
 const handleInit = () => __awaiter(void 0, void 0, void 0, function* () {

package/dist/core/parser.js

@@ -73,14 +73,21 @@ function getModuleNameFromPackage(operation) {
 /**
  * Processes the validated OpenAPI document into a structured format for code generation.
  * @param api The bundled OpenAPI document.
+ * @param excludePaths Paths to exclude (by prefix).
+ * @param includePaths Paths to include (by prefix). If provided, only these paths will be processed.
  * @returns A structured representation of modules and their endpoints.
  */
-const processApi = (api, excludePaths = []) => {
+const processApi = (api, excludePaths = [], includePaths = []) => {
     var _a, _b, _c, _d, _e, _f, _g;
     const modules = {};
     const allSchemas = ((_a = api.components) === null || _a === void 0 ? void 0 : _a.schemas) || api.definitions || {};
     const moduleFunctionNames = {};
     for (const path in api.paths) {
+        // 如果配置了 includePaths，只处理匹配的路径
+        if (includePaths.length > 0 && !includePaths.some(include => path.startsWith(include))) {
+            continue;
+        }
+        // 排除 excludePaths 中的路径
         if (excludePaths.some(exclude => path.startsWith(exclude))) {
             continue;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "czh-api",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A CLI tool to generate TypeScript API clients from Swagger/OpenAPI documents.",
   "main": "dist/index.js",
   "bin": {

package/src/commands/build.ts

@@ -3,7 +3,7 @@
  * @Author: czh
  * @Date: 2025-07-02 10:39:30
  * @LastEditors: Czh
- * @LastEditTime: 2025-07-02 11:47:00
+ * @LastEditTime: 2025-12-25 12:40:34
  */
 import chalk from 'chalk';
 import path from 'path';
@@ -23,6 +23,7 @@ interface IConfig {
     templates?: string;
     customImports?: string[];
     excludePaths?: string[];
+    includePaths?: string[];
 }
 
 export const handleBuild = async () => {
@@ -44,7 +45,7 @@ export const handleBuild = async () => {
         console.log(chalk.green('Swagger document fetched and bundled successfully.'));
 
         // Process the API document
-        const modules = processApi(api, config.excludePaths || []);
+        const modules = processApi(api, config.excludePaths || [], config.includePaths || []);
         console.log(chalk.blue('API processed into modules.'));
 
         // Clean output directory

package/src/commands/init.ts

@@ -3,7 +3,7 @@
  * @Author: czh
  * @Date: 2025-07-02 10:39:17
  * @LastEditors: Czh
- * @LastEditTime: 2025-07-02 11:45:10
+ * @LastEditTime: 2025-12-25 12:51:48
  */
 import chalk from 'chalk';
 import fs from 'fs/promises';
@@ -14,7 +14,8 @@ const defaultConfig = {
   outputDir: './src/api',
   templates: './czh-api-template',
   customImports: ['import http from "@/utils/http";'],
-  excludePaths: []
+  excludePaths: [],
+  includePaths: []
 };
 
 const templates = ['api.hbs', 'index.hbs', 'types.hbs'];

package/src/core/parser.ts

@@ -109,15 +109,22 @@ function getModuleNameFromPackage(operation: OpenAPIV3.OperationObject): string
 /**
  * Processes the validated OpenAPI document into a structured format for code generation.
  * @param api The bundled OpenAPI document.
+ * @param excludePaths Paths to exclude (by prefix).
+ * @param includePaths Paths to include (by prefix). If provided, only these paths will be processed.
  * @returns A structured representation of modules and their endpoints.
  */
-export const processApi = (api: OpenAPI.Document, excludePaths: string[] = []): Modules => {
+export const processApi = (api: OpenAPI.Document, excludePaths: string[] = [], includePaths: string[] = []): Modules => {
     const modules: Modules = {};
     const allSchemas =  (api as OpenAPIV3.Document).components?.schemas || (api as any).definitions ||{};
 
     const moduleFunctionNames: { [moduleName: string]: Set<string> } = {};
 
     for (const path in api.paths) {
+        // 如果配置了 includePaths，只处理匹配的路径
+        if (includePaths.length > 0 && !includePaths.some(include => path.startsWith(include))) {
+            continue;
+        }
+        // 排除 excludePaths 中的路径
         if (excludePaths.some(exclude => path.startsWith(exclude))) {
             continue;
         }