TypeScript：如何避免在BaseAPI所有子类中重复添加索引签名？

我基于TypeScript写了一套API管理代码，结构逻辑如下：

• BaseAPI是抽象类，用来统一管理TransactionAPI这类具体业务API类
• ApiManager维护所有接口端点的注册表，通过getEndpoints方法提取各个API类里的可用端点
• 因为TypeScript的类型检查要求，我给BaseAPI加了静态索引签名，但现在每个子类（比如FileAPI）如果不重复写一遍这个索引签名，就会触发报错：

BugFinder: Argument of type 'typeof FileAPI' is not assignable to parameter of type 'typeof BaseAPI'.BugFinder:
Index signature for type 'string' is missing in type 'typeof FileAPI'.

想修改代码结构，避免每个子类都重复编写索引签名，该怎么处理？

现有代码 #

base-api.ts #

import { FileAPI } from './file-api';
import { TransactionAPI } from './transaction-api';

export abstract class BaseAPI {
  static readonly [key: string]:
    | ApiCall<unknown> // 定义带泛型响应类型的单个API调用
    | { [subKey: string]: ApiCall<unknown> } // 嵌套API调用定义
    | undefined // 支持可选静态成员
    | (() => string);

  // 静态方法示例
  static getChannel(): string {
    return 'This is a static method';
  }
}

export interface ApiCall<T> {
  method: string; // HTTP方法，如POST、GET等
  endpoint: string; // 端点路径
  response: string
}

export class ApiManager {
  public static readonly endpointsRegistry: string[] = [
    ...this.getEndpoints(TransactionAPI),
    ...this.getEndpoints(FileAPI),
  ];

  private static getEndpoints(api: typeof BaseAPI): string[] {
    const endpoints: string[] = [];

    const extractEndpoints = (obj: { [key: string]: unknown }) => {
     // 实现细节无关紧要
    };

    extractEndpoints(api);
    return endpoints;
  }
}

transaction-api.ts #

import { ApiCall, ApiResponse, BaseAPI } from './api-manager';

export class TransactionAPI extends BaseAPI {
  // 为了满足BaseAPI的要求，显式添加了索引签名
  static readonly [key: string]:
    | ApiCall<unknown>
    | { [subKey: string]: ApiCall<unknown> }
    | undefined
    | (() => string);

  public static getChannel() {
    return '';
  }

  public static readonly CREATE: ApiCall<Transaction> = {
    method: 'POST',
    endpoint: 'transaction',
    response: {} as ApiResponse<Transaction>, // 响应占位符
  };
}

export class Transaction {
  id!: number;
  transactionDate!: Date;
  amount!: number;
}

file-api.ts #

import { ApiCall, ApiResponse, BaseAPI } from './api-manager';

export class FileAPI extends BaseAPI {
  public static getChannel() {
    return '';
  }
  public static readonly CREATE: ApiCall<File> = {
    method: 'POST',
    endpoint: 'file',
    response: {} as ApiResponse<File>, // 响应占位符
  };
}

export class File {
  name!: string; // 带扩展名的文件名
  mimeType!: string; // 文件MIME类型（如text/csv、application/pdf）
  size!: number; // 文件大小（字节）
  data!: string; // Base64编码的文件内容
}

核心思路是打破"子类必须继承带静态索引签名的抽象类"的约束，改用类型约束或元数据的方式适配ApiManager的需求，同时保留API类的结构完整性。

方案1：用类型别名替代静态索引签名继承（推荐） #

这个方案彻底消除子类重复代码，同时保留类型安全：

1. 先定义一个类型，描述API类的静态结构，不用挂载到BaseAPI上：

export type ApiClass = {
  readonly [key: string]:
    | ApiCall<unknown>
    | { [subKey: string]: ApiCall<unknown> }
    | undefined
    | (() => string);
  getChannel(): string; // 所有API类共有的静态方法
};

2. 修改BaseAPI，移除静态索引签名，只保留公共静态方法：

export abstract class BaseAPI {
  static getChannel(): string {
    return 'This is a static method';
  }
}

3. 修改ApiManager的getEndpoints方法参数类型为ApiClass，而非typeof BaseAPI：

private static getEndpoints(api: ApiClass): string[] {
  const endpoints: string[] = [];
  const extractEndpoints = (obj: { [key: string]: unknown }) => {
    // 原有实现逻辑不变
  };
  extractEndpoints(api);
  return endpoints;
}

所有继承BaseAPI的子类会自动满足ApiClass的类型约束，无需再重复编写索引签名。

方案2：利用satisfies关键字（TS 4.9+） #

如果你的TypeScript版本在4.9及以上，可以用satisfies约束子类结构，不用修改BaseAPI：

// file-api.ts
export class FileAPI extends BaseAPI {
  public static getChannel() {
    return '';
  }
  public static readonly CREATE: ApiCall<File> = {
    method: 'POST',
    endpoint: 'file',
    response: {} as ApiResponse<File>,
  };
} satisfies typeof BaseAPI; // 这里添加类型约束

不过这个方案需要每个子类都加satisfies标记，还是存在少量重复，优先级低于方案1。

方案3：重构为装饰器模式（长期优雅方案） #

彻底摆脱索引签名的困扰，用装饰器标记API端点，通过元数据收集信息：

1. 定义端点装饰器：

export function ApiEndpoint<T>(config: ApiCall<T>) {
  return function(target: any, propertyKey: string) {
    // 将端点信息存储到类的元数据中
    const existingEndpoints = Reflect.getMetadata('api:endpoints', target) || [];
    Reflect.defineMetadata('api:endpoints', [...existingEndpoints, config], target);
  };
}

2. 修改API类，用装饰器标记端点：

export class FileAPI extends BaseAPI {
  public static getChannel() {
    return '';
  }

  @ApiEndpoint({
    method: 'POST',
    endpoint: 'file',
    response: {} as ApiResponse<File>,
  })
  public static readonly CREATE!: ApiCall<File>;
}

3. 修改ApiManager的getEndpoints方法，从元数据提取端点：

private static getEndpoints(api: typeof BaseAPI): string[] {
  const endpoints = Reflect.getMetadata('api:endpoints', api) as ApiCall<unknown>[] | undefined;
  return endpoints?.map(ep => ep.endpoint) || [];
}

这个方案完全不需要索引签名，代码结构更清晰，也更符合TypeScript的类型安全设计理念。

内容的提问来源于stack exchange，提问作者b_it_s