API设计标准

API是两个系统之间交互的协议，在设计时需充分考虑清楚服务请求方和服务提供方的场景。

对外API是系统对API用户提供的服务，需要考虑到API用户的使用特点。本文提出了针对API用户的设计标准，作为参考。

设计要点

API设计时需要考虑以下方面：灵活性、一致性、兼容性

1. 灵活性，API用户使用程序调用接口，因此一个接口应该尽可能满足多种场景，减少限制；
2. 一致性，API用户学习接口有成本，因此不同的接口之间的术语和逻辑尽可能保持一致；
3. 兼容性，API用户的程序修改起来有成本，因此每次接口的更新需要保持向前兼容（即兼容旧版本）。

Rest接口设计

设计输出

Rest接口设计输出需包含以下完整内容

• 描述
• 方法：如 GET, POST
• 路径：如 /market/kline
• 请求参数：请求参数需要包括如下字段：
  • 名称
  • 数据类型
  • 是否必需
  • 默认值（如果不必需）
  • 说明
• 限频：如 10次/2秒
• 返回数据：返回数据需要包括如下字段
  • 名称
  • 数据类型