docs: 更新文档-关于 defineConfig & options.describe

Author: GreatAuk

README-en_US.md

@@ -45,21 +45,28 @@ create `openapi-ts-request.config.ts` file in the project root directory
 > the config file also supports **_.openapi-ts-request.ts_**, **_openapi-ts-request.config.cjs_** format, reference [cosmiconfig](https://github.com/cosmiconfig/cosmiconfig?tab=readme-ov-file#cosmiconfig)
 
 ```ts
-import type { GenerateServiceProps } from 'openapi-ts-request';
+import { defineConfig } from 'openapi-ts-request';
 
-export default {
-  // schemaPath: './openapi.json', // local openapi file
-  // serversPath: './src/apis', // interface storage path
+export default defineConfig({
   schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
-} as GenerateServiceProps;
+  serversPath: './src/apis',
+});
+
+// 或
+
+// import type { GenerateServiceProps } from 'openapi-ts-request';
+
+// export default {
+//   schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
+// } as GenerateServiceProps;
 ```
 
 support passing in array config for generate
 
 ```ts
-import type { GenerateServiceProps } from 'openapi-ts-request';
+import { defineConfig } from 'openapi-ts-request';
 
-export default [
+export default defineConfig([
   {
     schemaPath: 'http://app.swagger.io/v2/swagger.json',
     serversPath: './src/apis/app',
@@ -68,7 +75,22 @@ export default [
     schemaPath: 'http://auth.swagger.io/v2/swagger.json',
     serversPath: './src/apis/auth',
   },
-] as GenerateServiceProps[];
+]);
+
+// or
+
+// import type { GenerateServiceProps } from 'openapi-ts-request';
+
+// export default [
+//   {
+//     schemaPath: 'http://app.swagger.io/v2/swagger.json',
+//     serversPath: './src/apis/app',
+//   },
+//   {
+//     schemaPath: 'http://auth.swagger.io/v2/swagger.json',
+//     serversPath: './src/apis/auth',
+//   },
+// ] as GenerateServiceProps[];
 ```
 
 add the command in `script` of `package.json`: `"openapi": "openapi-ts",`
@@ -229,6 +251,7 @@ openapi -i ./spec.json -o ./apis
 | serversPath | no | string | './src/apis' | the folder path for the run results |
 | requestLibPath | no | string | 'axios' | custom request lib path, for example: '@/request', 'node-fetch' |
 | full | no | boolean | true | full replacement |
+| describe | no | string | - | description information, which will be used when using cli interactive operation mode |
 | enableLogging | no | boolean | false | open the log |
 | priorityRule | no | string | 'include' | priority rule, include/exclude/both |
 | filterCaseInsensitive | no | boolean | false | whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters |

README.md

@@ -291,6 +291,8 @@ openapi --i ./spec.json --o ./apis
 | customTemplates | {<br>[TypescriptFileType.serviceController]?: <T, U>(item: T, context: U) => string;<br>} | 自定义模板，详情请看源码 |
 | customRenderTemplateData | {<br>[TypescriptFileType]?: (list: any[], context: {fileName: string, params: Record<string, unknown>}) => any[]<br>} | 自定义文件生成时的 list 参数处理，支持对不同文件类型进行精细化控制 |
 
+[hooks 示例](https://github.com/openapi-ui/openapi-ts-request/blob/main/agents.md#-advanced-customization-hooks)
+
 ## Apifox-Config
 
 | 属性 | 类型 | 说明 | 必填 |
@@ -368,7 +370,8 @@ export default {
 4. 确保你的代码可以通过所有测试用例(新增功能需要添加新的功能测试用例)：`pnpm test:unit`
 5. 创建 changeset 文件通过命令：`pnpm changeset`
 6. 使用 commit 提交你的修改(需遵循 commitlint 规范)
-7. 发起 Pull Request
+7. 如果涉及文档，请同步更新 README.md、READMD-en_US.md、agents.md
+8. 发起 Pull Request
 
 ## 感谢
 

agents.md

@@ -102,6 +102,7 @@ else if (isNodeProject) {
 | `namespace` | string | `"API"` | TypeScript namespace | Custom namespace |
 | `templatesFolder` | string | - | Custom template directory | Custom templates |
 | `apifoxConfig` | object | - | Apifox-specific configuration | Apifox integration |
+| `describe` | string | - | description information | Using cli interactive operation mode |
 
 ### 3. Feature Requirements Mapping