最佳实践
最近更新时间: 2024-06-12 15:06:00
使用API网关将您的业务设计为 API 开放出来，那么在设计 API 时，为了方便您后续的使用，我们推荐您遵循以下规则设计 API：
URI的末尾不要添加“/”，多一个斜杠的语义容易有很大歧义，究竟是目录，还是资源，都有可能，容易造成调用中出现很多问题。
使用“-”提高URI的可读性，用“-”来连接单词这样可以使得URI便于理解。
禁止在URL中使用 “_” ，因为 “_” 有可能被文本查看器中的下划线特效遮掩，可读性较低。
避免使用大写字母，使用大写字母既不美观又容易出错。
不要在URI中包含扩展名，而应鼓励REST API客户端使用HTTP提供的格式选择机制Accept request header。