feat: uri模式下支持分组

Author: geekact

src/bin.ts

@@ -73,14 +73,9 @@ spinner.add({
 
     await Promise.all(
       ctx.configs.map(async (config, i) => {
-        const result = await generateTemplate(
-          ctx.docs[i]!,
-          config.projectName,
-          config.classMode || 'method',
-        );
         ctx.projects = {
           ...ctx.projects,
-          ...result,
+          ...(await generateTemplate(ctx.docs[i]!, config)),
         };
       }),
     );

src/define-config.ts

@@ -26,9 +26,13 @@ export interface OpenapiClientConfig {
   /**
    * 类的生成方式。默认值：`method`
    * - `method`，仅生成 `get|post|put|patch|delete` 几个方法，uri作为第一个参数传入
-   * - `uri`，所有的 method+uri 都会重新拼接成一个方法，比如`postUsersById()`
+   * - `uri`，把 method+uri 拼接成一个方法，比如 `POST /users/{id}` 会变成 `postUsersById()`
    */
   classMode?: 'method' | 'uri';
+  /**
+   * 根据Tag生成不同的分组，以类似`client.user.getUsers()`这种方式调用。仅在 `classMode=uri` 场景下生效。默认值：`true`
+   */
+  tagToGroup?: boolean;
 }
 
 export const defineConfig = (options: OpenapiClientConfig | OpenapiClientConfig[]) => {

src/lib/document-to-meta.ts

@@ -18,6 +18,7 @@ export type Metas = Record<
     responseTypes: string[];
     description?: string;
     deprecated?: boolean;
+    tags: string[];
   }[]
 >;
 
@@ -42,8 +43,9 @@ export const documentToMeta = (docs: OpenAPIV3.Document) => {
         params: parseParameters(docs, pathItem, methodItem, 'path'),
         ...parseRequestBody(docs, methodItem),
         ...parseResponse(docs, methodItem),
-        deprecated: methodItem.deprecated || false,
-        description: methodItem.description || '',
+        deprecated: methodItem.deprecated,
+        description: methodItem.description,
+        tags: methodItem.tags && methodItem.tags.length ? methodItem.tags : ['default'],
       });
     });
   });

src/lib/generate-template.ts

@@ -1,25 +1,34 @@
 import type { OpenAPIV3 } from 'openapi-types';
-import { upperFirst, camelCase } from 'lodash-es';
+import { upperFirst, camelCase, snakeCase } from 'lodash-es';
 import { documentToMeta, type Metas } from './document-to-meta';
 import { methods } from './adapter';
 import prettier from 'prettier';
 import { generateComments } from './generate-comments';
+import type { OpenapiClientConfig } from '../define-config';
 
 export const generateTemplate = async (
   docs: OpenAPIV3.Document,
-  projectName: string = '',
-  classMode: 'method' | 'uri',
+  config: Pick<OpenapiClientConfig, 'projectName' | 'classMode' | 'tagToGroup'>,
 ) => {
+  const { projectName, classMode = 'method', tagToGroup = true } = config;
   const className = `OpenapiClient${upperFirst(camelCase(projectName))}`;
   const metas = documentToMeta(docs);
+
+  const classTpl =
+    classMode === 'method'
+      ? generateMethodModeClass(className, metas)
+      : tagToGroup
+        ? generateUriModelClassWithNamespace(className, metas)
+        : generateUriModelClass(className, metas);
+
   const dts = `
     ${generateNamespaceTpl(className, metas)}
-    ${classMode === 'method' ? generateMethodModeClassForDTS(className, metas) : generateUriModelClassForDTS(className, metas)}
+    ${classTpl.dts}
     ${generatePathRelationTpl(className, metas)}
 `;
 
   const js = `
-  ${classMode === 'method' ? generateMethodModeClassForJS(className) : generateUriModeClassForJS(className, metas)}
+  ${classTpl.js}
   ${generateContentTypeTpl(className, metas)}
   `;
 
@@ -65,8 +74,9 @@ declare namespace ${className} {
 }`;
 };
 
-export const generateMethodModeClassForDTS = (className: string, metas: Metas) => {
-  return `
+export const generateMethodModeClass = (className: string, metas: Metas) => {
+  return {
+    dts: `
 declare class ${className} extends BaseOpenapiClient {
   ${methods
     .map((method) => {
@@ -98,11 +108,28 @@ declare class ${className} extends BaseOpenapiClient {
       BaseOpenapiClient.UserInputOpts['requestBodyType'],
       BaseOpenapiClient.UserInputOpts['responseType'],
     ];
-}`;
+}`,
+    js: `
+var ${className} = class extends BaseOpenapiClient {
+  ${methods
+    .map((method) => {
+      if (!metas[method].length) return '';
+      return `${method}(uri, opts) {
+        return this.request(uri, "get", opts);
+      }`;
+    })
+    .join('\n')}
+
+  getContentTypes(uri, method) {
+    return contentTypes${className}[method + " " + uri] || [void 0, void 0];
+  }
+};`,
+  };
 };
 
-export const generateUriModelClassForDTS = (className: string, metas: Metas) => {
-  return `
+export const generateUriModelClass = (className: string, metas: Metas) => {
+  return {
+    dts: `
 declare class ${className} extends BaseOpenapiClient {
   ${methods
     .flatMap((method) => {
@@ -116,40 +143,13 @@ declare class ${className} extends BaseOpenapiClient {
       });
     })
     .join('\n')}
-}`;
-};
 
-export const generateMethodModeClassForJS = (className: string) => {
-  return `
-var ${className} = class extends BaseOpenapiClient {
-  get(uri, opts) {
-    return this.request(uri, "get", opts);
-  }
-
-  post(uri, opts) {
-    return this.request(uri, "post", opts);
-  }
-
-  put(uri, opts) {
-    return this.request(uri, "put", opts);
-  }
-
-  patch(uri, opts) {
-    return this.request(uri, "patch", opts);
-  }
-
-  delete(uri, opts) {
-    return this.request(uri, "delete", opts);
-  }
-
-  getContentTypes(uri, method) {
-    return contentTypes${className}[method + " " + uri] || [void 0, void 0];
-  }
-};`;
-};
-
-export const generateUriModeClassForJS = (className: string, metas: Metas) => {
-  return `
+  protected getContentTypes(uri: string, method: string) : [
+    BaseOpenapiClient.UserInputOpts['requestBodyType'],
+    BaseOpenapiClient.UserInputOpts['responseType'],
+  ];
+}`,
+    js: `
 var ${className} = class extends BaseOpenapiClient {
   ${methods
     .flatMap((method) => {
@@ -165,7 +165,71 @@ var ${className} = class extends BaseOpenapiClient {
   getContentTypes(uri, method) {
     return contentTypes${className}[method + " " + uri] || [void 0, void 0];
   }
-};`;
+};`,
+  };
+};
+
+export const generateUriModelClassWithNamespace = (className: string, metas: Metas) => {
+  const namespaces = [
+    ...new Set(
+      methods.flatMap((method) => metas[method].flatMap((meta) => meta.tags || [])),
+    ),
+  ];
+
+  return {
+    dts: `
+declare class ${className} extends BaseOpenapiClient {
+  ${namespaces
+    .map((ns) => {
+      return `readonly ${snakeCase(ns)}: {
+      ${methods
+        .flatMap((method) => {
+          return metas[method]
+            .filter((meta) => meta.tags.includes(ns))
+            .map((meta) => {
+              const optional =
+                meta.query.optional && meta.params.optional && meta.body.optional;
+
+              return `
+              ${generateComments(meta)}
+              ${camelCase(meta.key)}(opts${optional ? '?' : ''}: ${className}_${method}_paths['${meta.uri}']['request']): Promise<${className}_${method}_paths['${meta.uri}']['response']>`;
+            });
+        })
+        .join('\n')}
+    }`;
+    })
+    .join('\n')}
+
+  protected getContentTypes(uri: string, method: string) : [
+    BaseOpenapiClient.UserInputOpts['requestBodyType'],
+    BaseOpenapiClient.UserInputOpts['responseType'],
+  ];
+}`,
+    js: `
+var ${className} = class extends BaseOpenapiClient {
+  ${namespaces
+    .map((ns) => {
+      return `${snakeCase(ns)} = {
+      ${methods
+        .flatMap((method) => {
+          return metas[method]
+            .filter((meta) => meta.tags.includes(ns))
+            .map((meta) => {
+              return `${camelCase(meta.key)}(opts) {
+                return this.request('${meta.uri}', '${method}', opts);
+              },`;
+            });
+        })
+        .join('\n')}
+      }`;
+    })
+    .join('\n')}
+
+  getContentTypes(uri, method) {
+    return contentTypes${className}[method + ' ' + uri] || [void 0, void 0];
+  }
+};`,
+  };
 };
 
 export const generateContentTypeTpl = (className: string, metas: Metas) => {