php做api接口的一些随笔

最早接触到的是mvc思想,在PHP的框架ThinkPHP的具体用法就是控制器指挥模型获取到数据之后,利用assign()将数据发送给模版进行渲染,后来接触到的几个后台管理也是这种方式。

但慢慢的,随着html5混合app的流行,php好像变的只需要提供接口就可以了。ThinkPHP的最新版本好像就是全面支持api。

模版做出来的手机网页,在手机浏览器中可以正常使用,但时流量消耗大。

app通过接口的json数据进行互动,流量消耗少。

下面说说对接口开发的认识。

一开始的工作时使用接口完成一个新闻类app的开发。接口是别人在写,写了多少给我多少,用什么问题反馈修改。

返回的内容主要分两大部分code码和data,code码1正常,0异常。但我觉得这样并不好,后来我设计的接口返回格式分三大部分code,tips,data。其中tips尽可能的多返回一些提示或错误的说明。

例如这样:{"code":0,"tips":"账号不存在","data":""}或者{"code":0,"tips":"密码错误!","data":null}

还有就是对方的接口说明文件写的不清楚,参数的格式要交代清楚,必选和可选要交代清楚。

我自己写的接口说明文件如下:

原文地址:https://www.cnblogs.com/tingfengqieyu/p/5133640.html