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;
});
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 144,481评论 1 305
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 61,908评论 1 258
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 95,710评论 0 214
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 41,372评论 0 183
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 49,216评论 1 262
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 38,949评论 1 178
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,558评论 2 275
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,308评论 0 168
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 29,183评论 7 237
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 32,675评论 0 214
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,416评论 2 217
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 30,757评论 1 232
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 24,314评论 1 33
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,215评论 2 213
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 31,682评论 3 214
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,665评论 0 9
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,091评论 0 170
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 33,687评论 2 233
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 33,830评论 2 237

推荐阅读更多精彩内容