文档中心 API 网关 最佳实践

最佳实践

最近更新时间:2019-07-31 13:00:18

使用API网关将您的业务设计为 API 开放出来,那么在设计 API 时,为了方便您后续的使用,我们推荐您遵循以下规则设计 API:

  1. URI 的末尾不要添加斜杠/,资源的 URL 的末尾多一个斜杠会产生歧义,容易被误认为是目录,导致在调用过程中产生误解。

  2. 使用中划线-提高 URI 的可读性,用中划线-来连接单词这样可以使得 URI 便于理解。

  3. 禁止在 URL 中使用下划线_,因为下划线_有可能被文本查看器中的下划线特效遮掩,可读性较低。

  4. 避免使用大写字母,使用大写字母既不美观又容易出错。

  5. 不要在 URI 中包含扩展名,而应鼓励 REST API 客户端使用HTTP提供的格式选择机制 Accept request header。