style: 代码优化等

Author: cloudcome

README.md

@@ -33,12 +33,9 @@ npm i -D openapi-axios
 const { defineConfig } = require('openapi-axios');
 
 module.exports = defineConfig({
-  openAPIs: [
-    {
-      // 将会生成 src/apis/swagger/petStore3.ts 文件
-      name: 'swagger/petStore3',
-      // 可以是一个 URL 链接或者本地路径（必须是 JSON 格式），或者一个 Open Api v3 文档对象
-      document: 'https://petstore31.swagger.io/api/v31/openapi.json',
+  modules: {
+      // 将会生成 src/apis/petStore3.ts 文件
+      'petStore3': 'https://petstore31.swagger.io/api/v31/openapi.json'
     },
   ],
 });
@@ -49,7 +46,7 @@ module.exports = defineConfig({
 # 根据配置文件生成typescript文件
 npx openapi-axios
 
-# 将会生成 src/apis/swagger/petStore3.ts 文件
+# 将会生成 src/apis/petStore3.ts 文件
 ```
 
 <details>
@@ -111,6 +108,7 @@ export type Pet = {
 // ... 省略 ...
 
 /**
+ * @module petStore3
  * @description Update an existing pet by Id
  * @summary Update an existing pet
  * @see pet Everything about your Pets {@link http://swagger.io Find out more}
@@ -134,7 +132,7 @@ export async function updatePet(data: Pet, config?: AxiosRequestConfig): AxiosPr
 然后你可以直接导入一个函数并使用它。 调用接口就像调用本地函数一样简单。
 
 ```ts
-import { updatePet } from '@/apis/swagger/petStore3';
+import { updatePet } from '@/apis/petStore3';
 
 // 类型安全
 const { data: pet } = await updatePet({

src/generators/Generator.ts

@@ -53,10 +53,10 @@ export class Generator extends Emitter<GeneratorEmits> {
         this.emit('end', payload);
     }
 
-    protected async generateOpenAPI(index: number, count: number, name: string, openAPIOptions: OpenAPIOptions, generatorOptions: StrictGeneratorOptions) {
+    protected async generateOpenAPI(index: number, count: number, module: string, openAPIOptions: OpenAPIOptions, generatorOptions: StrictGeneratorOptions) {
         const { cwd, dest, ...globalPrinter } = generatorOptions;
         const { document, ...scopePrinter } = openAPIOptions;
-        const fileName = `${name}.ts`;
+        const fileName = `${module}.ts`;
         const filePath = path.join(cwd, dest, fileName);
 
         // 1. 参数合并
@@ -70,7 +70,7 @@ export class Generator extends Emitter<GeneratorEmits> {
         const makePayload = (step: GeneratingStage): GeneratingPayload => ({
             index,
             count,
-            name,
+            module,
             stage: step,
             options,
             filePath,
@@ -85,7 +85,7 @@ export class Generator extends Emitter<GeneratorEmits> {
         // 3. 输出
         this.emit('process', makePayload('printing'));
         const printer = new Printer(openAPIV3Document, printerOptions);
-        const code = printer.print();
+        const code = printer.print({ module });
 
         // 4. 写入
         this.emit('process', makePayload('writing'));

src/generators/Logger.ts

@@ -14,7 +14,7 @@ export class Logger {
         console.log(
             chalk.cyanBright('▷'),
             chalk.yellowBright(`${step}/${payload.count}`),
-            payload.name,
+            payload.module,
             payload.stage,
             payload.stage === 'generated' ? path.relative(payload.options.cwd, payload.filePath) : '',
         );

src/generators/types.ts

@@ -43,7 +43,7 @@ export interface GeneratorPayload {
 export interface GeneratingPayload {
     index: number;
     count: number;
-    name: string;
+    module: string;
     stage: GeneratingStage;
     options: GeneratingOptions;
     filePath: string;

test/generators/Logger.test.ts

@@ -12,7 +12,7 @@ test('Logger', async () => {
     logger.pipeProcessEvent({
         index: 5,
         count: 99,
-        name: 'test',
+        module: 'test',
         stage: 'generated',
         filePath: '/a/b/c/d/e/f',
         options: {