在明确接口职责的条件下,尽量做到接口单一,即一个接口只做一件事,而非两件以上。很多非资深接口设计者,在设计接口时,总认为接口所做的事越多,越牛叉,这是非常严重的错误认识。 3.协议规范 在设计接口时,应明确接口协议,是采用HTTP协议,HTTPS协议还是FTP协议,要根据具体情况来定。 FTP协议(File Transfer Protocol...
然而,由于设备类型识别错误,可能导致充电宝“担任”Source角色而发生“电流倒灌”的现象,损坏两方设备(感谢关注公众号:硬件笔记本)。 Type-C接口规范通过CC引脚的一系列“上拉”和“下拉”的机制来区分Source、Sink以及DRP。对于Source设备,要求CC引脚配置上拉电阻Rp;对于Sink设备,要求CC引脚配置下拉电阻Rd; 而对于DRP...
2)功能是否按照接口文档实现 举例:比如博客园添加随笔,需要登录才能添加。也就是业务要求不支持游客添加随笔功能,如果设计一个没有登录的用户,然后去测试添加随笔接口,结果接口能添加到随笔,说明功能不正常,不符合需求和接口文档描述。 逻辑业务:是否依赖业务; 举例:该接口调用之前,需要调用登录接口,如果不登录也能请求...
//老接口voidoldService(A,B){//兼容新接口,传个null代替CnewService(A,B,null);}//新接口,暂时不能删掉老接口,需要做兼容。voidnewService(A,B,C){...} 3. 设计接口时,充分考虑接口的可扩展性 要根据实际业务场景设计接口,充分考虑接口的可扩展性。 比如你接到一个需求:是用户添加或者修改员工时,需要...
一：接口定义的原则 1. 易于理解：一个好的接口应该易于理解，简洁明了。用户应该能够快速而准确地理解接口所提供的功能，避免对接口的误解和错误使用。为此，接口的名称应该准确地描述其功能，方法和参数的命名应该简洁明了，遵循一致的命名规范。2. 一致性：一致性是一个好的接口设计的重要特征。不同的接口应该...
今天想和大家探讨一下如何设计一个良好的API接口,好的API设计需要同时考虑到这几个要素:标准化、兼容性、抽象性、简单性、高性能,可以说这几个要素缺一不可。 标准化 对于Web API标准化而言,一个非常好的案例就是Restful API。目前业界的Open API多数是基于Restful API规范设计的。 1、等级模型 需要注意的是Rest...
接口设计 一、接口设计规范:RESTful ①参考文档:理解RESTful架构、RESTful API 设计指南 ②HTTP协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源。
RestFul接口设计 一、接口编程 1、背景 随着互联网的发展, 尤其是移动互联为代表的Web3.0时代. 客户端层出不穷, 以APP、微信、PC浏览器为代表, 服务端业务逻辑是基本一致的。那么有没有一种方式可以做到”服务端一次编写, 客户端随时接入”呢? 流行的方案就是"接口编程"...
1、接口参数校验(入参和出参) 接口入参和出参都需要进行校验, ① 例如入参是否不能为空,入参数据长度,入参是否符合预期规则,很多bug由于未做参数校验导致,对于可能改变的参数建议设计为对象类型; ② 对于返回值,当返回值为空时是否返回为空串、空对象、空数组,需要与前端约定好。
API接口的网关服务,获取到该sign值,然后用相同的请求参数 + 时间戳 + 密钥拼接成一个字符串,用相同的m5算法生成另外一个sign,对比两个sign值是否相等。 前言 今天延续设计的话题,给大家总结了接口设计的18条军规,希望对你会有所帮助。 1. 签名 为了防止API接口中的数据被篡改,很多时候我们需要对API接口做签名。