Thinkjs rest API

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

注意:如果客户端是get请求过来自动执行getAction()方法,是post请求就执行postAction()方法,是delete请求就执行deleteAction()方法,是put请求就执行putAction()方法
// 使用 ES6 的语法继承该类
export default class extends think.controller.rest {
}

// 使用普通方式继承该类
module.exports = think.controller('rest', {
})

data = await this.modelInstance.where(filter).select()
data = data.map((obj)=> {
   delete obj.USEROPENID;  //删除obj.USEROPENID这个key (因为我们不想返回这个USEROPENID给用户)
   delete obj.HELPEROPENID; //删除obj.HELPEROPENID这个key(因为我们不想返回这个HELPEROPENID给用户)
   return obj
});

属性

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(){
    this.modelInstance.field('password', true); //过滤 password 字段(也就是不返回该字段)
    //this.modelInstance.fieldReverse('user,name'); //隐藏 user 和 name 字段(也就是不返回该字段)
  }
}
controller.getAction()

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

//方法实现,可以根据需要修改
export default class extends think.controller.rest {
  async getAction(){
    let data;
    // this.id是请求路径后面带有数字例如:http://127.0.0.1:8360/home/colleaguehelp/50   (模块/控制器/具体主键的id)
    if (this.id) {
      //this.modelInstance.getPk()是获取到数据库中的所以主键集合
      let pk = await this.modelInstance.getPk();
      data = await this.modelInstance.where({[pk]: this.id}).find(); //find()找到某条返回
      return this.success(data);
    }
    data = await this.modelInstance.select();  //select()返回全部
    return this.success(data);  //this.success(data)向客户端返回查找到的数据
  }
}
controller.postAction()

添加数据

//方法实现,可以根据需要修改
export default class extends think.controller.rest {

  async postAction(){
    let pk = await this.modelInstance.getPk();
    let data = this.get();
    delete data[pk];
    if(think.isEmpty(data)){
      return this.fail('data is empty');
    }
    let insertId = await this.modelInstance.add(data);
    return this.success({id: insertId});
  }
}
controller.putAction()

更新数据

//方法实现,可以根据需要修改
export default class extends think.controller.rest {
  async putAction(){
    if (!this.id) {
      return this.fail('params error');
    }
    let pk = await this.modelInstance.getPk();
    let data = this.get();
    delete data[pk];
    if (think.isEmpty(data)) {
      return this.fail('data is empty');
    }
    let rows = await 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));
  }
}

请求的一些例子:

let data = [];
const now = new Date();
const today = now.getFullYear() * 10000 + (now.getMonth() + 1) * 100 + now.getDate();
data = await this.modelInstance.where({   //modelInstance会找到数据库表名跟所在的控制器名对应起来
    STATE: [2, 5],  //STATE为2或5
    VALIDDATE: {'<' : today}   //VALIDDATE小于today
}).limit(5).order('ENDTIME DESC').select();  //limit(5)限制5条,order('ENDTIME DESC')按字段ENDTIME进行降序,DESC是降序
data = data.map((obj)=> {
    delete obj.OPENID;  //删除OPENID
    delete obj.USEROPENID;  //删除USEROPENID
    return obj;
});

推荐阅读更多精彩内容