feat(parser): 新增nameFormatter支持自定义方法名 Implement #247

Author: StreakingMan

README.md

@@ -154,15 +154,16 @@ console.log(pet);
 | `openAPIs`    | `OpenAPIOptions[]` | `true`  | OpenAPIOptions 列表，至少需要配置一个 | 无                           |
 
 ## `ParserOptions` 签名：
-| 参数名                    | 类型       | 可选性     | 描述         | 默认值                |
-|------------------------|----------|---------|------------|--------------------|
-| `cwd`                  | `string` | `false` | 当前工作路径     | `process.cwd()`    |
-| `okCode`               | `number` | `false` | ok 的响应码    | `200`              |
-| `okMediaType`          | `number` | `false` | ok 的响应类型   | `application/json` |
-| `requestPathTypeName`  | `string` | `false` | 请求路径参数类型名称 | `ReqPath`          |
-| `requestQueryTypeName` | `string` | `false` | 请求查询参数类型名称 | `ReqParams`        |
-| `requestBodyTypeName`  | `string` | `false` | 请求体参数类型名称  | `ReqData`          |
-| `responseBodyTypeName` | `string` | `false` | 响应体参数类型名称  | `ResData`          |
+| 参数名                    | 类型         | 可选性     | 描述                                                                                           | 默认值                  |
+|------------------------|------------|---------|----------------------------------------------------------------------------------------------|----------------------|
+| `cwd`                  | `string`   | `false` | 当前工作路径                                                                                       | `process.cwd()`      |
+| `okCode`               | `number`   | `false` | ok 的响应码                                                                                      | `200`                |
+| `okMediaType`          | `number`   | `false` | ok 的响应类型                                                                                     | `application/json`   |
+| `nameFormatter`        | `function` | `false` | 自定义name解析格式化方法，函数签名 ```(name:string,method:string,url:string,operationId?:string)=>string``` | ```(name) => name``` |
+| `requestPathTypeName`  | `string`   | `false` | 请求路径参数类型名称                                                                                   | `ReqPath`            |
+| `requestQueryTypeName` | `string`   | `false` | 请求查询参数类型名称                                                                                   | `ReqParams`          |
+| `requestBodyTypeName`  | `string`   | `false` | 请求体参数类型名称                                                                                    | `ReqData`            |
+| `responseBodyTypeName` | `string`   | `false` | 响应体参数类型名称                                                                                    | `ResData`            |
 
 ## `PrinterOptions` 签名：
 | 参数名                   | 类型       | 可选性     | 描述                                  | 默认值                         |

src/parsers/BaseParser.ts

@@ -11,6 +11,7 @@ export class BaseParser {
     cwd: process.cwd(),
     okCode: 200,
     okMediaType: JSON_MIME,
+    nameFormatter: (name) => name,
     requestPathTypeName: 'ReqPath',
     requestQueryTypeName: 'ReqParams',
     requestBodyTypeName: 'ReqData',

src/parsers/PathsParser.ts

@@ -2,6 +2,7 @@ import { OpenAPIV3 } from 'openapi-types';
 import { ComponentsParser } from './ComponentsParser';
 import { BLOB_MIME, JSON_MIME, HTTP_METHODS } from './const';
 import type { TypeItem, TypeList, TypeOperation, TypeOperations, TypeOrigin } from './types';
+import type { Named } from './Named';
 
 export class PathsParser extends ComponentsParser {
   parsingUrl = '';
@@ -42,7 +43,12 @@ export class PathsParser extends ComponentsParser {
   parseOperation(operation: OpenAPIV3.OperationObject): TypeOperation {
     const { parameters, requestBody: requestBodySchema } = operation;
     const { pathTypes, queryTypes } = this.parseOperationParameters(parameters);
-    const name = this.named.nextOperationId(this.parsingMethod, this.parsingUrl, operation.operationId);
+    const nameParams: Parameters<Named['nextOperationId']> = [
+      this.parsingMethod,
+      this.parsingUrl,
+      operation.operationId,
+    ];
+    const name = this.options.nameFormatter(this.named.nextOperationId(...nameParams), ...nameParams);
     const requestPathTypeName = this.named.nextTypeName(name + this.options.requestPathTypeName);
     const requestQueryTypeName = this.named.nextTypeName(name + this.options.requestQueryTypeName);
     const requestBodyTypeName = this.named.nextTypeName(name + this.options.requestBodyTypeName);

src/parsers/types.ts

@@ -1,4 +1,5 @@
 import type { OpenAPIV3Document } from '../types/openapi';
+import type { Named } from './Named';
 
 export type TypeUnit = 'number' | 'string' | 'boolean' | 'never' | 'object' | 'array' | 'any';
 
@@ -49,6 +50,10 @@ export interface ParserOptions {
    */
   okMediaType?: string;
 
+  nameFormatter?: (
+    name: ReturnType<Named['nextOperationId']>,
+    ...params: Parameters<Named['nextOperationId']>
+  ) => string;
   requestPathTypeName?: string;
   requestQueryTypeName?: string;
   requestBodyTypeName?: string;

test/parsers/PathsParser.test.ts

@@ -90,6 +90,54 @@ test('empty path item method responses keys + specify operationId', async () =>
   ]);
 });
 
+test('custom name formatter', async () => {
+  const parser = new PathsParser(
+    {
+      info: {
+        title: 'test',
+        version: '1.0.0',
+      },
+      openapi: '3.0.0',
+      paths: {
+        '/pet': {
+          get: {
+            operationId: 'findPet',
+            responses: {},
+          },
+        },
+        '/cat': {
+          get: {
+            responses: {},
+          },
+        },
+      },
+    },
+    {
+      nameFormatter: (name, method, url, operationId) => {
+        return `custom_${name}`;
+      },
+    }
+  );
+
+  const t = parser.parsePaths();
+  expect(t).toEqual<TypeOperations>([
+    {
+      name: `custom_getCat`,
+      method: OpenAPIV3.HttpMethods.GET,
+      url: '/cat',
+      request: {},
+      response: {},
+    },
+    {
+      name: `custom_findPet`,
+      method: OpenAPIV3.HttpMethods.GET,
+      url: '/pet',
+      request: {},
+      response: {},
+    },
+  ]);
+});
+
 test('operationId is reserved', async () => {
   const parser = new PathsParser({
     info: {