feat: 新增method+uri生成方法

Author: geekact

src/base-openapi-client.ts

@@ -44,7 +44,7 @@ export abstract class BaseOpenapiClient {
     return uri;
   }
 
-  protected request(uri: string, method: Methods, opts: BaseOpenapiClient.FullOpts) {
+  protected request(uri: string, method: Methods, opts: BaseOpenapiClient.FullOpts = {}) {
     const contentTypes = this.getContentTypes(uri, method);
     const requestBodyType = opts.requestBodyType || contentTypes[0] || 'application/json';
     const responseType = opts.responseType || contentTypes[1] || 'json';

src/bin.ts

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

src/define-config.ts

@@ -23,6 +23,12 @@ export interface OpenapiClientConfig {
    * 比如项目名为`demo`，则导出的类为`OpenapiClientDemo`
    */
   projectName?: string;
+  /**
+   * 类的生成方式。默认值：`method`
+   * - `method`，仅生成 `get|post|put|patch|delete` 几个方法，uri作为第一个参数传入
+   * - `uri`，所有的 method+uri 都会重新拼接成一个方法，比如`postUsersById()`
+   */
+  classMode?: 'method' | 'uri';
 }
 
 export const defineConfig = (options: OpenapiClientConfig | OpenapiClientConfig[]) => {

src/lib/document-to-meta.ts

@@ -16,6 +16,8 @@ export type Metas = Record<
     body: { optional: boolean; types: string[] };
     response: { types: string[] };
     responseTypes: string[];
+    description?: string;
+    deprecated?: boolean;
   }[]
 >;
 
@@ -40,6 +42,8 @@ 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 || '',
       });
     });
   });

src/lib/generate-template.ts

@@ -3,21 +3,23 @@ import { upperFirst, camelCase } from 'lodash-es';
 import { documentToMeta, type Metas } from './document-to-meta';
 import { methods } from './adapter';
 import prettier from 'prettier';
+import { generateComments } from './generate-comments';
 
 export const generateTemplate = async (
   docs: OpenAPIV3.Document,
   projectName: string = '',
+  classMode: 'method' | 'uri',
 ) => {
   const className = `OpenapiClient${upperFirst(camelCase(projectName))}`;
   const metas = documentToMeta(docs);
   const dts = `
     ${generateNamespaceTpl(className, metas)}
-    ${generateClassForDTS(className, metas)}
+    ${classMode === 'method' ? generateMethodModeClassForDTS(className, metas) : generateUriModelClassForDTS(className, metas)}
     ${generatePathRelationTpl(className, metas)}
 `;
 
   const js = `
-  ${generateClassForJS(className)}
+  ${classMode === 'method' ? generateMethodModeClassForJS(className) : generateUriModeClassForJS(className, metas)}
   ${generateContentTypeTpl(className, metas)}
   `;
 
@@ -63,7 +65,7 @@ declare namespace ${className} {
 }`;
 };
 
-export const generateClassForDTS = (className: string, metas: Metas) => {
+export const generateMethodModeClassForDTS = (className: string, metas: Metas) => {
   return `
 declare class ${className} extends BaseOpenapiClient {
   ${methods
@@ -96,31 +98,48 @@ declare class ${className} extends BaseOpenapiClient {
       BaseOpenapiClient.UserInputOpts['requestBodyType'],
       BaseOpenapiClient.UserInputOpts['responseType'],
     ];
-}
-  `;
+}`;
+};
+
+export const generateUriModelClassForDTS = (className: string, metas: Metas) => {
+  return `
+declare class ${className} extends BaseOpenapiClient {
+  ${methods
+    .flatMap((method) => {
+      return metas[method].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')}
+}`;
 };
 
-export const generateClassForJS = (className: string) => {
+export const generateMethodModeClassForJS = (className: string) => {
   return `
 var ${className} = class extends BaseOpenapiClient {
-  get(uri, ...rest) {
-    return this.request(uri, "get", rest[0] || {});
+  get(uri, opts) {
+    return this.request(uri, "get", opts);
   }
 
-  post(uri, ...rest) {
-    return this.request(uri, "post", rest[0] || {});
+  post(uri, opts) {
+    return this.request(uri, "post", opts);
   }
 
-  put(uri, ...rest) {
-    return this.request(uri, "put", rest[0] || {});
+  put(uri, opts) {
+    return this.request(uri, "put", opts);
   }
 
-  patch(uri, ...rest) {
-    return this.request(uri, "patch", rest[0] || {});
+  patch(uri, opts) {
+    return this.request(uri, "patch", opts);
   }
 
-  delete(uri, ...rest) {
-    return this.request(uri, "delete", rest[0] || {});
+  delete(uri, opts) {
+    return this.request(uri, "delete", opts);
   }
 
   getContentTypes(uri, method) {
@@ -129,6 +148,26 @@ var ${className} = class extends BaseOpenapiClient {
 };`;
 };
 
+export const generateUriModeClassForJS = (className: string, metas: Metas) => {
+  return `
+var ${className} = class extends BaseOpenapiClient {
+  ${methods
+    .flatMap((method) => {
+      return metas[method].map((meta) => {
+        return `
+        ${camelCase(meta.key)}(opts) {
+          return this.request('${meta.uri}', "${method}", opts);
+        }`;
+      });
+    })
+    .join('\n')}
+
+  getContentTypes(uri, method) {
+    return contentTypes${className}[method + " " + uri] || [void 0, void 0];
+  }
+};`;
+};
+
 export const generateContentTypeTpl = (className: string, metas: Metas) => {
   return `
   const contentTypes${className} = {