11、API 数据处理与资源标识符设计

API 数据处理与资源标识符设计

在 API 开发中，数据处理和资源标识符的设计是至关重要的环节。合理的数据处理方式能确保数据的准确传输和有效使用，而设计良好的资源标识符则能方便对资源进行唯一标识和访问。

数据处理相关要点

在数据处理方面，我们需要考虑多种数据类型及其特性。

默认值处理

与列表不同，在大多数序列化格式和语言中，区分空映射值（{}）和空值（null）相对容易。可以让空值表示 API 根据其他请求信息对该字段采取其认为最合适的操作，而空映射则表示该映射不应包含任何数据，这本身也是一种有意义的声明。

数据类型使用建议

• 布尔值 ：最好用于标志，命名时应使真值表示“积极”方面，例如使用 enableFeature 而非 disableFeature 。
• 数值 ：应具有真正的数值意义，而非仅由数字组成。在不支持合适原生表示的语言中，为避免大数（超过 32 或 64 位）或浮点运算问题，数值应序列化为字符串。
• 字符串 ：应使用 UTF - 8 编码，对于用作任何类型标识符的字符串，需规范化为规范化形式 C。
• 枚举 ：通常应避免使用，可依赖字符串值，并在服务器端进行验证，而非客户端。
• 列表 ：应视为原子集合项，仅在客户端可单独寻址。
• <