rest controller（Rest 接口处理）

think.controller.rest 继承自 think.controller.base，用来处理 Rest 接口。

使用 ES6 的语法继承该类

export default class extends think.controller.rest {

}

使用普通方式继承该类

module.exports = think.controller("rest", {

})

属性

controller._isRest

标识此 controller 对应的是 Rest 接口。如果在 init 方法里将该属性设置为false，那么该 controller 不再是一个 Rest 接口。

controller._method

获取 method 方式。默认从 http method 中获取，但有些客户端不支持发送 delete, put 之类的请求，所以可以设置为从 GET 里的一个参数获取。

export default class extends think.controller.rest {
  init(http){
    super.init(http);
    //设置 _method，表示从 GET 参数获取 _method 字段的值
    //如果没有取到，则从 http method 中获取
    this._method = "_method";
  }
}

controller.resource

当前 Rest 对应的 Resource 名称。

controller.id

资源 ID

controller.modelInstance

资源对应 model 的实例。

方法

controller.__before()

可以在魔术方法__before中进行字段过滤，分页，权限校验等功能。

export default class extends think.controller.rest{
  __before(){
    //过滤 password 字段
    this.modelInstance.field("password", true);
  }
}

controller.getAction()

获取资源数据，如果有 id，拉取一条，否则拉取列表。

//方法实现，可以根据需要修改
export default class extends think.controller.rest {
  * getAction(){
    let data;
    if (this.id) {
      let pk = yield this.modelInstance.getPk();
      data = yield this.modelInstance.where({[pk]: this.id}).find();
      return this.success(data);
    }
    data = yield this.modelInstance.select();
    return this.success(data);
  }
}

controller.postAction()

添加数据

//方法实现，可以根据需要修改
export default class extends think.controller.rest {
  * postAction(){
    let pk = yield this.modelInstance.getPk();
    let data = this.post();
    delete data[pk];
    if(think.isEmpty(data)){
      return this.fail("data is empty");
    }
    let insertId = yield this.modelInstance.add(data);
    return this.success({id: insertId});
  }
}

controller.deleteAction()

删除数据

//方法实现，可以根据需要修改
export default class extends think.controller.rest {
  * deleteAction(){
    if (!this.id) {
      return this.fail("params error");
    }
    let pk = yield this.modelInstance.getPk();
    let rows = yield this.modelInstance.where({[pk]: this.id}).delete();
    return this.success({affectedRows: rows});
  }
}

controller.putAction()

更新数据

//方法实现，可以根据需要修改
export default class extends think.controller.rest {
  * putAction(){
    if (!this.id) {
      return this.fail("params error");
    }
    let pk = yield this.modelInstance.getPk();
    let data = this.post();
    delete data[pk];
    if (think.isEmpty(data)) {
      return this.fail("data is empty");
    }
    let rows = yield this.modelInstance.where({[pk]: this.id}).update(data);
    return this.success({affectedRows: rows});
  }
}

controller.__call()

找不到方法时调用

export default class extends think.controller.rest {
  __call(){
    return this.fail(think.locale("ACTION_INVALID", this.http.action, this.http.url));
  }
}

文档地址：https://github.com/75team/www.thinkjs.org/tree/master/view/zh-CN/doc/2.0/api_controller_rest.md