API开发第四篇：定义客户端/服务端接口协议

最新推荐文章于 2025-09-09 09:22:00 发布

原创

最新推荐文章于 2025-09-09 09:22:00 发布 · 5.6k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#服务端 #接口 #设计 #api协议设计

在进行API开发的时候，需要事先定义好app与server交互的数据格式，这样前端人员与服务端人员才能够事先决定好如何获取数据、如何解析数据、如何传输协议。
在我看来目前接口协议无外乎这三种情况：
1. json数据进行交互
2. xml数据进行交互
3. 自定义数据格式交互

自定义数据格式进行前后端的数据交互，需要花费较大的精力，而且需要很有经验的人设计的协议才会确保各个平台的兼容以及良好的可阅读性。并且解析、封装都需要自己来用代码实现，很多第三方库都没办法用上。因为这里我不进行讨论。主要说说json与xml作为交互数据。

我在我的response中封装了json与xml。客户端可以根据自己的需要进行选择是获取json数据还是xml。指定方法是在请求的url中指定format=json/xml。这里为了程序的健壮，我会默认指定一种数据格式的返回，也就是如果客户端没有或者忘记设置format时，默认返回json数据。

json数据的封装，在php中用json来进行数据交互是非常方便。实现代码：

    private static function jsonSucEncode($code, $msg, $datas){
   
   
        if(!is_numeric($code)){
            return '';
        }

        $ret = array(
                'succode'   => $code,
                'sucmsg'    => $msg,
                'datas'     => $datas,
        );

        echo json_encode($ret);
    }