了解API接口基本知识,日常工作者可以更清楚需要输出什么样的接口,什么是关键接口,才能更好地进行功能规划的提前布局和后续的压力测试。
我们基本遇到的API接口的使用场景分为下面三个场景:
01-公司内部前后端数据交互
前端想要获得某些数据,将传入参数通过URL接口地址,传递给服务器,服务器根据传入的参数了解到前端要获得什么数据,去数据库查询获取数据,然后将所需数据返回给前端,前端拿到数据做相应的页面展示。
比如后端拿到前端传递过来的数据(用户名和密码)和数据库中用户信息做比对,如果一致则返回给前端一个状态,并且返回用户的相关数据(昵称、个人信息、购物车信息、收藏的商品等等),这些数据同样是以JSON的形式传回给前端。如果用户名或密码不一致,也返回给前端一个状态。前端根据得到的状态做出页面的相应效果:登录按钮变为退出、显示用户昵称、显示购物车信息、显示收藏信息、登录框隐藏等,如果用户名密码不匹配则显示相应的提示信息。
02-公司提供开放API接口
网站的服务商将自己的网站服务封装成一系列API(ApplicationProgrammingInterface,应用编程接口)开放出去,供第三方开发者使用,这种行为就叫做开放网站的API,所开放的API就被称作OpenAPI(开放API)。
网站提供开放平台的API后,可以吸引一些第三方的开发人员在该平台上开发商业应用,平台提供商可以获得更多的流量与市场份额,第三方开发者不需要庞大的硬件与技术投资就可以轻松快捷的创业,从而达到双赢的目的,开放API是大平台发展、共享的途径,让开发者开发一个有价值应用,付出的成本更少,成功的机会更多。
03-业务嵌套、可部署移动端
可对接至小程序、H5、移动APP等平台,实现随时随地获取数据。
现在各家的网站、平台、系统、APP、小程序都出了自己的API接口供第三方来对接。这里总结下需要注意的几点:
跨平台性,接口要能够支持不同的终端,如Android、iOS、windowsphone以及桌面软件、Web端等。良好的响应速度接口要为移动客户端考虑,如移动端要写2个特殊接口下拉刷新和上拉加载更多优化移动端的网络情况和耗电量通用的数据交换格式如xml和json等设计API要考虑安全问题,调用者应该是经过自己授权。
开发者API接口调用
对于私密代理、隧道代理、独享代理、开放代理,快代理都提供了API接口,方便开发者批量获取代理ip列表。
接口返回数据的格式支持文本、json、xml。
对于代理提取API,您可以在线生成API链接,内置到您的程序中。
正确返回结果
返回的
code
字段为0代表成功,非0代表失败。
以获取开放代理接口为例,正确的返回结果样例如下:
{
msg:,
code:0,
data:{
count:10,
proxy_list:[
...:80,
..31.:,
...:,
.62..50:,
...:,
.57.42.79:81,
...70:,
...:80,
58...:,
.95..76:80
]
}
}
错误返回结果
以获取开放代理接口为例,错误的返回结果样例如下:
{code:-3,msg:参数错误,data:}
公共错误码