feat: 添加looseInputNumber配置，支持将number类型解析为number | string

Author: geekact

README.md

@@ -232,6 +232,20 @@ await client.user.getUsersById(opts);
 
 **注意**：如果operationId字段不存在，则仍以`method+uri`的规则生成
 
+### looseInputNumber
+
+类型：`boolean`<br>
+默认值：`false`
+
+开启后，`query`和`params`对象中的属性类型，`number`会被解析为`number | string`。<br>
+不管是否开启都不会对请求造成影响，因为最终都会拼接到请求链接上变成一段完整的uri。
+
+```typescript
+// http://host:port/users/1?tag=234
+openapi.getUsersById({ params: { id: 1 }, query: { tag: 234 } });
+openapi.getUsersById({ params: { id: '1' }, query: { tag: '234' } });
+```
+
 ### onDocumentLoaded
 
 类型：`(docs: Document) => Document | void`

src/base-openapi-client.ts

@@ -2,6 +2,10 @@ import type { OpenapiClientAdapter, Methods } from './lib/adapter';
 import { utils } from './utils';
 
 export namespace string {
+ /**
+ * '12345'
+ */
+ export type Number = string;
  export type BigInt = string;
  /**
  * 2020-02-12T07:20:50.52Z

src/define-config.ts

@@ -77,6 +77,18 @@ export interface OpenapiClientConfig {
  * - 如果配置了项目名，默认值：`./src/openapi/${projectName}.ts`
  */
  outputFile?: string;
+ /**
+ * 开启后，`query`和`params`对象的属性类型中，`number`会被解析为`number | string`。默认值：`false`
+ *
+ * 不管是否开启都不会对请求造成影响，因为最终都会拼接到请求链接上变成一段完整的uri。
+ *
+ * ```typescript
+ * // http://host:port/users/1?tag=234
+ * openapi.getUsersById({ params: { id: 1 }, query: { tag: 234 } });
+ * openapi.getUsersById({ params: { id: '1' }, query: { tag: '234' } });
+ * ```
+ */
+ looseInputNumber?: boolean;
 }
 
 export type DefineConfigOptions =

src/lib/document-to-meta.ts

@@ -28,6 +28,7 @@ export type Metas = Record<
 export const documentToMeta = (
  docs: OpenAPIV3.Document,
  rpcName: OpenapiClientConfig['rpcName'],
+ looseInputNumber?: boolean,
 ) => {
  const metas: Metas = {
  get: [],
@@ -49,8 +50,8 @@ export const documentToMeta = (
  ? methodItem.operationId
  : `${method}_${uri.replaceAll(/{(.+?)}/g, '_by_$1')}`,
  ),
- query: parseParameters(docs, pathItem, methodItem, 'query'),
- params: parseParameters(docs, pathItem, methodItem, 'path'),
+ query: parseParameters(docs, pathItem, methodItem, 'query', looseInputNumber),
+ params: parseParameters(docs, pathItem, methodItem, 'path', looseInputNumber),
  ...parseRequestBody(docs, methodItem),
  ...parseResponse(docs, methodItem),
  deprecated: methodItem.deprecated,

src/lib/generate-template.ts

@@ -9,11 +9,19 @@ import { pickContentTypes } from './template';
 
 export const generateTemplate = async (
  docs: OpenAPIV3.Document,
- config: Pick<OpenapiClientConfig, 'projectName' | 'classMode' | 'rpcName'>,
+ config: Pick<
+ OpenapiClientConfig,
+ 'projectName' | 'classMode' | 'rpcName' | 'looseInputNumber'
+ >,
 ) => {
- const { projectName = '', classMode = 'rest', rpcName = 'method+uri' } = config;
+ const {
+ projectName = '',
+ classMode = 'rest',
+ rpcName = 'method+uri',
+ looseInputNumber = false,
+ } = config;
  const className = `OpenapiClient${upperFirst(camelCase(projectName))}`;
- const metas = documentToMeta(docs, rpcName);
+ const metas = documentToMeta(docs, rpcName, looseInputNumber);
 
  const classTpl =
  classMode === 'rest'

src/lib/parse-parameters.ts

@@ -8,6 +8,7 @@ export const parseParameters = (
  pathItem: OpenAPIV3.PathItemObject,
  methodItem: OpenAPIV3.OperationObject,
  key: string,
+ looseInputNumber?: boolean,
 ): { optional: boolean; types: [string] | [] } => {
  const parameters = (methodItem.parameters || [])
  .concat(pathItem.parameters || [])
@@ -20,7 +21,14 @@ export const parseParameters = (
  return `${generateComments(parameter)}${parameter.name}${parameter.required ? '' : '?'}: ${parseSchema(docs, parameter.schema)}
  `;
  })
- .filter(Boolean);
+ .filter(Boolean)
+ .map((type) => {
+ if (!looseInputNumber) return type;
+ return type
+ .replaceAll('(number)', '(number | string.Number)')
+ .replaceAll('(number | null)', '(number | string.Number | null)');
+ });
+
  return {
  optional: parameters.every((parameter) => !parameter.required),
  types: types.length ? [`{ ${types.join(';\n')} }`] : [],

test/lib/parse-parameters.test.ts

@@ -35,6 +35,7 @@ const docs = getBasicDocument({
  },
  { $ref: '#/components/parameters/refA' },
  { $ref: '#/components/parameters/refB' },
+ { $ref: '#/components/parameters/refC' },
  ],
  },
  },
@@ -54,12 +55,18 @@ docs.components = {
  required: true,
  schema: { type: 'integer' },
  },
+ refC: {
+ name: 'ref_c',
+ in: 'path',
+ required: true,
+ schema: { type: 'integer', nullable: true },
+ },
  },
 };
 
 test('解析查询字符串', () => {
- const result = parseParameters(docs, docs.paths['/']!, docs.paths['/']!.get!, 'query');
- expect(result).toMatchInlineSnapshot(`
+ expect(parseParameters(docs, docs.paths['/']!, docs.paths['/']!.get!, 'query', false))
+  .toMatchInlineSnapshot(`
  {
  "optional": false,
  "types": [
@@ -74,21 +81,55 @@ test('解析查询字符串', () => {
  ],
  }
  `);
+
+ expect(parseParameters(docs, docs.paths['/']!, docs.paths['/']!.get!, 'query', true))
+ .toMatchInlineSnapshot(`
+ {
+ "optional": false,
+ "types": [
+ "{ foo: (number | string.Number)
+ ;
+ bar?: (number | string.Number)
+ ;
+ ref_a?: (number | string.Number)
+ ;
+ bazz: (string)
+ }",
+ ],
+ }
+ `);
 });
 
 test('解析路径参数', () => {
- const result = parseParameters(docs, docs.paths['/']!, docs.paths['/']!.get!, 'path');
- expect(result).toMatchInlineSnapshot(`
- {
- "optional": false,
- "types": [
- "{ id: (number)
- ;
- ref_b: (number)
- }",
- ],
- }
- `);
+ expect(parseParameters(docs, docs.paths['/']!, docs.paths['/']!.get!, 'path', false))
+ .toMatchInlineSnapshot(`
+ {
+ "optional": false,
+ "types": [
+ "{ id: (number)
+ ;
+ ref_b: (number)
+ ;
+ ref_c: (number | null)
+ }",
+ ],
+ }
+ `);
+
+ expect(parseParameters(docs, docs.paths['/']!, docs.paths['/']!.get!, 'path', true))
+ .toMatchInlineSnapshot(`
+ {
+ "optional": false,
+ "types": [
+ "{ id: (number | string.Number)
+ ;
+ ref_b: (number | string.Number)
+ ;
+ ref_c: (number | string.Number | null)
+ }",
+ ],
+ }
+ `);
 });
 
 test('未找到参数则变成可选', () => {