10、Web API 数据类型使用指南

Web API 数据类型使用指南

1. 枚举类型

枚举类型在强类型编程语言中很常见，类似于程序员的下拉选择器。虽然它有验证和压缩的优点，但在 Web API 中使用时，往往会带来灵活性和清晰度降低的问题。

例如以下代码：

enum Color {
  Brown = 1,  // #A
  Blue,
  Green, // #B
}

interface Person {
  id: string;
  name: string;
  eyeColor: Color;  // #C
}

• A：定义了一组可能的颜色。

• B：这个列表后续可能会添加更多选项。

• C：使用枚举来处理人的眼睛颜色。

使用整数来表示枚举值时，如 person.eyeColor 被设置为 2，这比设置为 “blue” 更难理解，尤其在查看请求日志时。而且，当服务器添加新的枚举值时，客户端需要更新本地映射，否则代码会出现混乱。

因此，当可以使用其他类型（如字符串）时，应尽量避免使用枚举类型，特别是在可能添加新值或有相关标准的情况下。例如，对于有效的文件类型，使用允许特定媒体类型的字符串字段（如 “application/pdf” 或 “application/msword”）会更安全。

2. 列表类型

列表是一种简单的集合数据类型，由其他数据类型（如字符串、