中国教育和科研计算机网
EDU首页 |  中国教育 |   高校科技 |   教育信息化 |   CERNET
教育信息化

资讯 | 专题 会议 观点 专栏 访谈 企业 产品 CIO 技术 校园信息化 下一代互联网 IPv6视频课堂

中国教育网 > 教育信息化
您现在的位置: EDU首页 > 教育信息化 > 技  术
校园社交网络API设计方法
http://www.edu.cn   2014-06-30 中国教育网络 作者:仲玮 范轶 代成琴

字体选择:【大】 【中】 【小】

  具体设计方案

  校园社交网络的主要用户群体是校园师生用户,均需通过校园统一身份认证进行登录,因此A P I 的身份验证也应以此为基础,通过分享用户信息、社会关系、消息、头像等方式将信息扩展到其他第三方系统。采用分层的方式对公共业务进行设计并提供有效的API供模块通信。在REST风格中,资源标识结构和U R I 模式的设计与API 设计一脉相承,其设计如图1 所示。

  1.HTTP Method 是REST 利用Http 实现的对资源的CURD 功能,它提供了一个操作资源的统一接口,包括GET/POST/PUT/DELETE 等。对于任何资源的操作都应该对应到前面方法中。

  2. REST被称为面向资源的开发,这说明对资源的抽象是设计API 的一个重要环节。{resources} 用于表示校园社交网络API 系统的主体资源名,如用户属性、标签、头像、社会关系等,{ action _name } 则用于抽象对于资源的操作,同时与HTTP Method相对应,根据HTTP 请求实现不同的对象操作。

  社交网络中的资源,在描述了某种事物的同时,有时还存在着一定的层次结构关系。比如,系从属于某个学院,班级从属于系;学生信息可以从属于班级,也可以从属于某个公寓。当资源有这种层次关系的时候,需要使用复合的U R I 模式来帮助开发者更好地理解和设计资源。

  3. 开发者在发送一个REST API 的请求同时,针对相同的资源根据场景的不同可能会希望得到不同的返回形式。比如使用javascript时希望得到JSON 的返回,而使用C + + 时可能希望得到XML 的返回。为了提供这种完备的内容协商能力,在这里设计了{ format } 参数,使用URI 的模式直接用于定义响应和请求中的资源表述格式。

  4. 参数。在A P I 中U R I 应设计的尽量简短,这里使用参数的方式用于结果过滤、排序、搜索、分页等相关功能。但过多的参数会导致URL 的可读性变差,更有甚者,可能会导致URL 过长,使得API请求无法执行。因此参数的设置应在合理的范围内使用,必要时设置别名来代替常用的过滤、搜索请求。

  URI 是RESTFUL API 设计中非常重要的一个环节,在通过URI 定义好了资源与允许的操作之后,为实现RESTFUL API, 还须在以下几方面进行设计。

页面功能 【打印】 【关闭】 【我有话说

MOOC风暴来袭

版权所有:中国教育和科研计算机网网络中心 CERNIC,CERNET,京ICP备15006448号-16,京网文[2017]10376-1180号

关于假冒中国教育网的声明 | 有任何问题与建议请联络:Webmaster@staff.cernet.com