首页 > 代码库 > [php] 编写接口的规范
[php] 编写接口的规范
一. 接口按请求人可以分为两种:
一种是被其他内部项目调用的接口(包括js异步请求的接口和定时程序)。
另一种是对外的接口,主要提供给外部开发者调用的。
两种接口最大区别就是,内部接口不需要太严格的身份验证,而对外接口需要严格的身份验证,加密解密方式各种各样,其中最常见最简单的就是http basic验证,例如我们的大后台弹出的账号和密码弹窗 就是用了basic验证,输入账号和密码才能通过验证。但是如果内部接口涉及到重要的操作,不希望被他人恶意请求的话,还是要做一点加密验证的。
二. 无论是哪一种接口,都应该考虑到下面的问题:
1.安全。参数安全:这个我们有$_INPUT基本就足够了。是否需要身份验证:如果只是内部通知类/回调类的接口的话就算被恶意请求也不会影响数据正常,这种的话可以完全不做验证,举个栗子,我做个一个同步订单状态的接口,里面的流程是,查询订单状态有问题的订单,然后更新这些订单的状态。这种接口不需要返回任何值,就算被坏人恶意调用也不会有毛线影响的,那就根本没必要做身份验证了。所以这个是否加验证是按照接口实际逻辑决定的。
2.能否重复请求。例如某个接口是根据传入的订单号,插入一条数据,需要做好重复请求的判断,避免插入多条数据。
三. 编写接口规范
1. 用 try...catch...结构去写。(主要是 throw 可以随时结束程序,这样很爽~)
2. 返回状态码,不要返回success等于true或者false,如果要编写文档,关于不同错误码的含义也应该写明白,方便调用方查询出错原因。
下面直接看栗子:
<?php $code = 200; // 接口状态码 $name = trim($_INPUT[‘name‘]); $age = trim($_INPUT[‘age‘]); if (empty($name)) { $code = 401; throw new Exception(‘名字不能为空‘); } if (!is_numeric($age)) { $code = 402; throw new Exception(‘年龄必须由数字组成‘); } $database_obj = new database_class(); $res = $database_obj->save($name, $age); if ( !$res ) { $code = 403; throw new Exception(‘保存数据失败‘); } $msg = ‘ok‘;} catch ( Exception $e ) { $msg = $e->getMessage();}output_json($code,$data,$msg); // $data可以放置需要返回的数据// output_json函数在大function里面有~如果不想引入大function的话可以复制一份到自己项目
// ========END=======
[php] 编写接口的规范
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。