多语言展示
当前在线:615今日阅读:113今日分享:31

api接口开发时,需要注意的问题

未接触过接口API开发的程序员,对于API接口开发的概念和理解一般都很懵懂。先来介绍下API这几个单词的概念。API全称是:Application Programming Interface。翻译:应用程序接口。里对api的解释是:是一些预先定义的函数,或指软件系统不同组成部分衔接的约定。目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问原码,或理解内部工作机制的细节。理解了概念,那api的开发我们要怎么一步步进行和在开发中我们需要注意哪些问题和事项?
方法/步骤
1

制定好API规范和确定好需求。开发前制定好规范和流程,接口必须绘制流程图,并确保流程与需求一致。比如定好数据返回的通用参数和格式。用的较多的有xml和json,建议用json,json比xml的好处更多。

2

尽量精简返回的数据。接口数据因符合需要什么返回什么的原则,如查询账号名,很多人可能是select * from usb_user where id=1,但是接口一定要select name from usb_user where id=1。接口返回数据是要开销和要流量的,数据返回能少则少,如此能大大的提高性能。

3

API的返回或请求的参数类型要严格。要注意参数的类型,如整型的数据一定要转为int,因为有些开发语言如java、object-c语言对数据类型比较严格,类型不对会照成闪退。

4

接口文档必须要写而且要写好。按照模块写,要书写规范,最好的格式是:接口请求地址;请求参数(包括参数名、类型、是否必填);测试参数举例;返回参数(参数名,并注明每个参数的含义)。如此即使以后项目很大,以不会照成维护困难的问题。

5

一定要确保代码的正确性。要验证确保代码正确无误,生成环境中要屏蔽掉错误信息,避免头部有额外的输出,照成返回的json等数据解析失败而导致闪退等。

6

要优化代码的性能。app要求响应迅速,这样才能给用户比较好的体验感。所以移动接口端在处理业务逻辑的时候,要避免不要执行太复杂的sql语句,或者含有大量的循环,能做成缓存的尽量做缓存,比如将首页的热点模块信息可以存到redis缓存中。在不考虑网速的情况下,比较理想的接口响应时间应该是200毫秒以内。

7

不要随意更改旧接口。比如app,一旦发布,有人使用之后,接口就不要乱修改了。升级也是,修改要在保证接口原有结构之上进行额外的扩展,否则会导致调用旧版接口出现bug。

8

注意接口的安全。安全高于一切,必须要保证接口的安全。电话号码等敏感信息在传输的过程中一定要加密,否则可能会被别人抓包到。拿取用户信息的接口一定要验证权限,以防止接口被恶意调用,泄密用户信息,甚至篡改信息。

推荐信息