8、API 设计：命名、资源布局与关系选择

API 设计：命名、资源布局与关系选择

1. 命名的重要性

在 API 设计中，命名是一个关键环节。好的命名应具备简单、表达性强和可预测的特点。例如，在接口设计中，如果不明确字段的单位，可能会导致错误。以下是两个不同版本的接口示例：

interface CalculateImpulseResponse {
  impulse: number;                    
}
interface CalculateManeuverRequest {
  impulse: number;                    
}

在这个示例中， impulse 字段没有单位，这意味着我们可能会错误地将一个接口的输出作为另一个接口的输入。而如果在字段名中包含单位，错误就会更加明显：

interface CalculateImpulseResponse {
  impulsePoundForceSeconds: number;   
}
interface CalculateManeuverRequest {
  impulseNewtonSeconds: number;       
}

从这个例子可以看出，明确的命名能够帮助我们避免错误，特别是在不同团队协作时，更能凸显其价值。

另外，在 API 设计中还存在一些关于命名的要点：
- 对于语言、语法和语法（以及其他任意选择），通常正确的做法是选择一种