口设计以资源为中心让接口易于理解和使用比较直观。 数据交换采用或格式大大简化了数据的处理和传输过程。 但严格遵循 风格也有一些缺陷 协议的动词受限 当业务需求变得复杂时仅依赖于的动词方法来对资源操作可能不足以满足需求这时往往需要通过接口名称来进一步区分。此外一些特定的请求如和可能会在网络传
输过程中被某些防火墙设备
拦截。 包含其可读性。如果需要基于统计接口的调用次数需要对具有相同的不同参数进行额外的处理。 状态码的表达性差 使用如等标准的状态码不足以描述复杂的业务场景的状态。 建议接口设计遵循以下准则 限制方法的使用仅采用和。 避免在中包含参数占位符尽量使用的
参数传参。 使用自定义的业务状态 有增强性能的高级布 码来提供更丰富的响应信息。 分组原则 根据业务领域对开放进行分组。例如店铺商品库存订单物流客户营销。 标准产品一般都基于进行架构设计根据业务领域组织开放是普遍采用的最佳实践。当需要改进或变更某个特定业务领域的功能时开发人员可以直接找到相关的组进行修改不会影响到其他领域的。 对于三方开发人员可以更容易地找到与某个业务功能相关的因为它们通过业务域的划分逻辑组织在一起。 版本
管理 为了统一和清晰地标
识不同版本的相同接口建议将版本号放置 细胞P数据 在接口路径的末尾示例如下 老版本_ 新版本_/返回数据 每个接口的响应数据应遵循统一的或格式规范并且至少应包含以下关键字段 状态码 ()表示请求的总体结果通常用于标识操作的
成功或异常状态。 消息 ()提供关于状态码的详细描述以帮助理解请求的具体结果。 数据 ()包含与请求相关的具体业务信息和数据。 六安全措施 接口签名 为开发者分配K开发者标识确保唯一和K用于接口加密确保不易被穷举生成算法不易被猜测。 按照请求参
数名的字母升序排列非空请求参数包含K使用键值对的格式即k&k拼接成字符串。 在字符串最后拼接上k得到字符串。 对字符串进行运算得到值。请求时携带参数K和只有拥有合法的身份K和正确的签名才能放行。这样就解决了身份验证和参数篡改问题即使请
