API接口设计需要注意的那些事儿

  随着前后端的分离,api 接口变得越来越重要,作为前后端通信的接口,api 变得非常重要,而且它的设计也是非常难以掌握。不仅要考虑安全性,还要考虑可维护性,以及今后的升级等等。

  如何才能设计出更好的 api 接口,我认为以下几点需要注意。

  接口一致性

  这里说的一致性指的是编码规范要统一,不能各个接口使用不一样的编码风格。对于返回格式的处理也是一样,要统一返回格式,返回码也要统一,对于403,404的处理要保持一致。

  授权认证

  大部分接口都是需要授权认证的,因此我们需要对接口的授权认证进行判断,这样可以过滤掉大部分的非法访问。

  接口健康性检查

  我们应该设计一个监控系统或者一个接口来实时监控我们的服务,如果接口出现了问题,我们应该能够第一时间发现,同样,对于每个接口的访问请求我们都要有日志记录的存储。

  版本管理

  无论是小程序,还是app,还是网站,我们都是需要版本升级的,而提前设计好版本,可以避免因为升级导致旧的服务无法正常工作,我们要保证在升级的时候,新旧版本的服务都能正常运转。

  参数接收判断

  对于接口参数的个数,参数的类型,我们都要进行判断处理,对于一些非法字段,我们要及时发现并处理,总之,用户传送的信息,我们总要保持怀疑态度去处理它。

  尽量采用restful风格

  虽然restful风格被一些人质疑,但是目前来看,它还是最好的接口设计风格,通过采用restful风格,可以让接口语义更加明确 ,规范,优雅省去了大部分 无意义的沟通,通过使用不同的http状态码,可以非常清楚地帮助用户理解接口的返回情况。

  提供完整详细的api文档

  无论我们的接口设计得多么规范,多么易懂,我们都需要提供一份完整的api文档,同时我们还需要提供一些请求范例,这样用户在使用的时候才会更加清楚,也能避免一些错误的请求。

  错误返回要明确

  对于错误信息返回的时候尽量要明确,是程序问题,还是查找问题,还是参数问题,或者其他原因,给出明确具体的错误原因,非常方便我们对问题的处理。

  统一设计分页

  对于资源的请求都采用分页返回,一方面减少了资源的返回,一方面减少了服务器的开销。

  做好限流控制

  你永远不知道你的用户会怎样使用你的接口,可能它会因为错误地返回结果而不停地重试接口,我们要能够对频繁请求进行限制。

途傲科技为中小企业提供网站制作、网站建设、微信H5、微信小程序,多商户平台,多级分销系统,APP开发,手机网站,HTML5多端自适应网站,营销型企业站建设,及对技术人才的培养等都积累与沉淀了丰富的心得和实战经验。

如果您有想法,可以将需求提交给我们【免费提交需求,获取解决方案】

免责声明:文章部分内容收集于互联网,不代表本站的观点和立场,如有侵权请联系删除。

发表评论

您的电子邮箱地址不会被公开。

QQ客服
运营电话
您好,有任何疑问请与我们联系!