feat: 将查询参数序列号进请求路径中 (close: #34, close: #39)

fjc0k · Aug 5, 2020 · ac43e58 · ac43e58
1 parent 2787d51
commit ac43e58
Show file tree

Hide file tree

Showing 7 changed files with 651 additions and 56 deletions.
diff --git a/src/Generator.ts b/src/Generator.ts
@@ -605,6 +605,11 @@ export class Generator {
  const paramNamesLiteral = JSON.stringify(paramNames)
  const paramNameType = paramNames.length === 0 ? 'string' : `'${paramNames.join('\' | \'')}'`
 
+ // 支持查询参数
+ const queryNames = (interfaceInfo.req_query /* istanbul ignore next */ || []).map(item => item.name)
+ const queryNamesLiteral = JSON.stringify(queryNames)
+ const queryNameType = queryNames.length === 0 ? 'string' : `'${queryNames.join('\' | \'')}'`
+
  // 转义标题中的 /
  const escapedTitle = String(interfaceInfo.title).replace(/\//g, '\\/')
 
@@ -669,6 +674,7 @@ export class Generator {
  ${JSON.stringify(interfaceInfo.path)},
  ${JSON.stringify(syntheticalConfig.dataKey)},
  ${paramNameType},
+ ${queryNameType},
  ${JSON.stringify(isRequestDataOptional)}
  >>
 
@@ -687,6 +693,7 @@ export class Generator {
  responseBodyType: ResponseBodyType.${interfaceInfo.res_body_type},
  dataKey: dataKey${categoryUID},
  paramNames: ${paramNamesLiteral},
+ queryNames: ${queryNamesLiteral},
  requestDataOptional: ${JSON.stringify(isRequestDataOptional)},
  }
 

diff --git a/src/helpers.ts b/src/helpers.ts
@@ -66,18 +66,37 @@ export function parseRequestData(requestData?: any): { data: any, fileData: any
  * 准备要传给请求函数的参数。
  */
 export function prepare(requestConfig: RequestConfig, requestData: any): RequestFunctionParams {
- let requestPath = requestConfig.path
+ let requestPath: string = requestConfig.path
  const {data, fileData} = parseRequestData(requestData)
- if (Array.isArray(requestConfig.paramNames) && requestConfig.paramNames.length > 0 && data != null && typeof data === 'object' && !Array.isArray(data)) {
- Object.keys(data).forEach(key => {
- if (requestConfig.paramNames.indexOf(key) >= 0) {
- // ref: https://github.com/YMFE/yapi/blob/master/client/containers/Project/Interface/InterfaceList/InterfaceEditForm.js#L465
- requestPath = requestPath
- .replace(new RegExp(`\\{${key}\\}`, 'g'), data[key])
- .replace(new RegExp(`/:${key}(?=/|$)`, 'g'), `/${data[key]}`)
- delete data[key]
- }
- })
+ if (data != null && typeof data === 'object' && !Array.isArray(data)) {
+ // 替换路径参数
+ if (Array.isArray(requestConfig.paramNames) && requestConfig.paramNames.length > 0) {
+ Object.keys(data).forEach(key => {
+ if (requestConfig.paramNames.indexOf(key) >= 0) {
+ // ref: https://github.com/YMFE/yapi/blob/master/client/containers/Project/Interface/InterfaceList/InterfaceEditForm.js#L465
+ requestPath = requestPath
+ .replace(new RegExp(`\\{${key}\\}`, 'g'), data[key])
+ .replace(new RegExp(`/:${key}(?=/|$)`, 'g'), `/${data[key]}`)
+ delete data[key]
+ }
+ })
+ }
+
+ // 追加查询参数到路径上
+ let queryString = ''
+ if (Array.isArray(requestConfig.queryNames) && requestConfig.queryNames.length > 0) {
+ Object.keys(data).forEach(key => {
+ if (requestConfig.queryNames.indexOf(key) >= 0) {
+ if (data[key] != null) {
+ queryString += `${(queryString ? '&' : '')}${encodeURIComponent(key)}=${encodeURIComponent(data[key])}`
+ }
+ delete data[key]
+ }
+ })
+ }
+ if (queryString) {
+ requestPath += `${(requestPath.indexOf('?') > -1 ? '&' : '?')}${queryString}`
+ }
  }
  return {
  ...requestConfig,

diff --git a/src/types.ts b/src/types.ts
@@ -466,6 +466,7 @@ export interface RequestConfig<
  Path extends string = any,
  DataKey extends string | undefined = any,
  ParamName extends string = any,
+ QueryName extends string = any,
  RequestDataOptional extends boolean = any,
 > {
  /** 接口 Mock 地址，结尾无 `/` */
@@ -486,6 +487,8 @@ export interface RequestConfig<
  dataKey: DataKey,
  /** 路径参数的名称列表 */
  paramNames: ParamName[],
+ /** 查询参数的名称列表 */
+ queryNames: QueryName[],
  /** 请求数据是否可选 */
  requestDataOptional: RequestDataOptional,
 }