feat: 文档js内容也增加注释

Author: geekact

openapi/rpc-group-mode.js

@@ -3,12 +3,19 @@ var OpenapiClient = class extends BaseOpenapiClient {
     getUsers: (opts) => {
       return this.request('/users', 'get', opts);
     },
+    /**
+     * 获取单个用户信息
+     */
     getUsersById: (opts) => {
       return this.request('/users/{id}', 'get', opts);
     },
     postUsers: (opts) => {
       return this.request('/users', 'post', opts);
     },
+    /**
+     * 接口已弃用，请使用 /users
+     * @deprecated
+     */
     postUsersV1: (opts) => {
       return this.request('/users/v1', 'post', opts);
     },

openapi/rpc-mode.js

@@ -3,6 +3,9 @@ var OpenapiClient = class extends BaseOpenapiClient {
     return this.request('/users', 'get', opts);
   }
 
+  /**
+   * 获取单个用户信息
+   */
   getUsersById(opts) {
     return this.request('/users/{id}', 'get', opts);
   }
@@ -11,6 +14,10 @@ var OpenapiClient = class extends BaseOpenapiClient {
     return this.request('/users', 'post', opts);
   }
 
+  /**
+   * 接口已弃用，请使用 /users
+   * @deprecated
+   */
   postUsersV1(opts) {
     return this.request('/users/v1', 'post', opts);
   }

src/lib/generate-template.ts

@@ -134,8 +134,7 @@ declare class ${className}<T extends object = object> extends BaseOpenapiClient<
           meta.query.optional && meta.params.optional && meta.body.optional;
 
         return `
-        ${generateComments(meta)}
-        ${camelCase(meta.key)}(opts${optional ? '?' : ''}: ${className}_${method}_paths['${meta.uri}']['request'] & BaseOpenapiClient.UserInputOpts<T>): Promise<${className}_${method}_paths['${meta.uri}']['response']>`;
+        ${generateComments(meta)}${camelCase(meta.key)}(opts${optional ? '?' : ''}: ${className}_${method}_paths['${meta.uri}']['request'] & BaseOpenapiClient.UserInputOpts<T>): Promise<${className}_${method}_paths['${meta.uri}']['response']>`;
       });
     })
     .join('\n')}
@@ -146,7 +145,7 @@ var ${className} = class extends BaseOpenapiClient {
     .flatMap((method) => {
       return metas[method].map((meta) => {
         return `
-        ${camelCase(meta.key)}(opts) {
+        ${generateComments(meta)}${camelCase(meta.key)}(opts) {
           return this.request('${meta.uri}', "${method}", opts);
         }`;
       });
@@ -181,9 +180,7 @@ declare class ${className}<T extends object = object> extends BaseOpenapiClient<
               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'] & BaseOpenapiClient.UserInputOpts<T>): Promise<${className}_${method}_paths['${meta.uri}']['response']>`;
+              return `${generateComments(meta)}${camelCase(meta.key)}(opts${optional ? '?' : ''}: ${className}_${method}_paths['${meta.uri}']['request'] & BaseOpenapiClient.UserInputOpts<T>): Promise<${className}_${method}_paths['${meta.uri}']['response']>`;
             });
         })
         .join('\n')}
@@ -201,7 +198,7 @@ var ${className} = class extends BaseOpenapiClient {
           return metas[method]
             .filter((meta) => meta.tags.includes(ns))
             .map((meta) => {
-              return `${camelCase(meta.key)}: (opts) => {
+              return `${generateComments(meta)}${camelCase(meta.key)}: (opts) => {
                 return this.request('${meta.uri}', '${method}', opts);
               },`;
             });

test/lib/generate-template.test.ts

@@ -142,7 +142,6 @@ test('完整的类型提示', async () => {
         getUsers(
           opts: OpenapiClient_get_paths["/users"]["request"] & BaseOpenapiClient.UserInputOpts<T>,
         ): Promise<OpenapiClient_get_paths["/users"]["response"]>;
-
         getUsersById(
           opts?: OpenapiClient_get_paths["/users/{id}"]["request"] & BaseOpenapiClient.UserInputOpts<T>,
         ): Promise<OpenapiClient_get_paths["/users/{id}"]["response"]>;
@@ -355,6 +354,7 @@ describe('类', () => {
         contentTypes: [],
         responseTypes: [],
         tags: ['user'],
+        description: '这里有一个注释',
       },
     ],
   });
@@ -401,6 +401,9 @@ describe('类', () => {
           opts?: Client_get_paths['/']['request'] & BaseOpenapiClient.UserInputOpts<T>,
         ): Promise<Client_get_paths['/']['response']>;
 
+        /**
+         * 这里有一个注释
+         */
         patchUsers(
           opts?: Client_patch_paths['/']['request'] & BaseOpenapiClient.UserInputOpts<T>,
         ): Promise<Client_patch_paths['/']['response']>;
@@ -413,6 +416,9 @@ describe('类', () => {
           return this.request('/', 'get', opts);
         }
 
+        /**
+         * 这里有一个注释
+         */
         patchUsers(opts) {
           return this.request('/', 'patch', opts);
         }
@@ -504,6 +510,9 @@ describe('类', () => {
             opts?: Client_get_paths['/']['request'] & BaseOpenapiClient.UserInputOpts<T>,
           ): Promise<Client_get_paths['/']['response']>;
 
+          /**
+           * 这里有一个注释
+           */
           patchUsers(
             opts?: Client_patch_paths['/']['request'] & BaseOpenapiClient.UserInputOpts<T>,
           ): Promise<Client_patch_paths['/']['response']>;
@@ -523,6 +532,10 @@ describe('类', () => {
           getUsers: (opts) => {
             return this.request('/', 'get', opts);
           },
+
+          /**
+           * 这里有一个注释
+           */
           patchUsers: (opts) => {
             return this.request('/', 'patch', opts);
           },