1. RESTful API设计的一点经验

    前段时间的工作涉及产品开放API的设计与实现,整个过程大致可分为以下几个步骤:

    1. 根据需求、原有数据库设计等,花了半天左右的工夫完成初稿;
    2. 就初稿与相关同事进行讨论,确定一些细节问题,逐步完善;
    3. 根据设计稿,基于Yii框架,配置路由,实现用户身份认证模块;
    4. 基于步骤3,逐个实现业务相关API;
    5. 对部分代码进行重构,减少不必要的代码重复。主要使用Yii控制器的beforeAction方法来实现多层过滤器。

    设计

    考虑到RESTful API简洁明了的接口表现形式,一开始我们就一致确定使用RESTful风格的API。参考以前自己使用多个开放平台API的经验, 及Github的开放API文档,大致完成设计初稿。

    资源

    RESTful API主要有两个核心:

    1. HTTP协议的4个谓词 - GET、POST、PUT、DELETE,分别对应“查询”、“新增”、“更新”、“删除”4种操作
    2. 资源(resource)

    RESTful风格API的设计,最难之处,我认为就是“资源”。

    “资源”是什么?“资源”并不是对应数据库中一个一个数据表,“资源 …

    Tagged as : 笔记 RESTful

Page 1 / 1