企业IM (或业务系统）web api的json格式设计思考（原创）

在企业IM开发中，经常用到和业务系统的数据交换，在中国企业最常见的比如组织架构变更，一般在客户端加密保存了组织架构树（便于快速的查询和树展示），当HR或OA或AD域这些管控企业组织架构的数据发生改变，需要IM服务器推送最新的组织架构，如果推送整个组织架构，数据量非常大（千人以上时），恰当的方式是：仅对变化量通过版本比对进行更新，而不是整体更新。

实际上，不仅仅是组织架构变更的，所有的http web api设计都可以参考这个设计。

取个名字：动词解析式Json数据格式 （Verb Parsing Json，简称VPJ，哈哈）。简要说明:

创建新数据：

{ "create": {"table1": [ {"verb": value}, {"verb": value}, ...],"table2": [ {"verb": value}, {"verb": value}, ...], }}

例1,添加同事的vcard（根据username）：

{ "create": { "ofVCard": ["add": {"username": "zhangsan", "vcard": "<vCard xmlns="vcard-temp"><N><FAMILY/> <GIVEN>张三</GIVEN> </N> <ORG><ORGNAME/> </ORG>......</vCard>"} ] } }  

更新数据：

{ "update": {"table1": [ {"verb": value}, {"verb": value}, ...],"table2": [ {"verb": value}, {"verb": value}, ...], }}

 

例1,更新电话号码（根据ID）：

{ "update": { "ofUser": ["edit": {"id": 10002, "phone": "13710699999"} ] } }  

 

例2,更新电话号码（根据USERNAME）：

{ "update": { "ofUser": ["edit": {"username": “wangxin”, "phone": "13710699999"} ] } }  

 

例3,更新一位同事电话号码，同时增加一个新人，同时删除2位同事（根据USERNAME）：

{ "update":

{

"ofUser": ["edit": {"username": “wangxin”, "phone": "13710699999"} ]

"ofUser": ["add": {"username": “zhangsan”, "phone": "13710688888", "name": "张三", "email": "[e-mail]"} ]

"ofUser": ["remove": {"username": “lisi”} ]

"ofUser": ["remove": {"username": “wangwu”} ]

}

}  

 

例4,删除一个同事的Vcard（根据USERNAME）：

{ "update": { "ofVCard": [{"remove": {"username": zhangsan} }] } }

 

总之，就是一个动词控制api。

客户端实现代码和openfire服务器端插件代码不赘述。