傻妞web插件编写指南

开发完傻妞web插件有一段时间了,但是没看到多少人编写插件,特意编写此文帮助大家入门

傻妞是什么

傻妞是一个非常强大机器人框架，可以自己开发js实现非常多的功能。

傻妞web插件简介

傻妞本来是纯机器人聊天框架,但是有时候只是文本聊天做某些操作不太方便,所以作者开发了原版web插件.又因为原版web插件性能和编写及其不方便,所以我改进了原版傻妞web插件,让其性能和易用性提升一个了档次.本文只讨论新版web插件

helloWorld

新建helloWorld.js文件,输入以下内容并保存

__response.json('hello world!')

将helloWorld.js放入plugin/web/hello
重启傻妞
访问http://傻妞ip:傻妞端口/hello/helloWorld

目录结构

 plugin
  `-- web
      |-- 插件1                 #插件主目录,也是该插件访问路径,要求只能字母+数字
      |   |-- $beforeRequest.js #请求任意js插件前会执行该js,用于鉴权和初始化参数
      |   |-- xxx.js            #自定义插件,要求名字只能是字母+数字,插件名为访问路径
      |   |-- xxx.js            #只支持1级路径,也就是GET test/a和 POST test/a/b/c都会访问a.js,可以使用importJs自己做路由
      |   |-- $afterRequest.js  #请求任意js插件后会执行该js
      |   `-- static            #静态资源目录
      |       |-- css           #样例,css文件目录
      |       |   |-- xxx.css   #css文件
      |       |   `-- xxx.css   #css文件
      |       |-- js            #样例,静态js文件目录
      |       |   |-- xxx.js    #静态js文件
      |       |   `-- xxx.js    #静态js文件
      |       |-- xxxx          #样例,任意自定义文件目录
      |       |   `-- xxx.xxx   #样例,任意文件
      |       |-- index.html    #入口html
      |       `-- xxx.html      #自定义其他html
      | -- 插件2                #其他web插件
      |    `-- xxx.js           #自定义js插件
      `-- 插件3                 #其他web插件

api介绍

补充说明

• index.html会在访问插件时会默认加载,并且没有index.html路径,如果多页面,推荐不要使用index.html
• $beforeRequest.js中设置了状态码或者使用了send方法将不会执行该路径对应的js插件,但是会执行$afterRequest.js
• $afterRequest.js一定会执行,哪怕前面代码报错了也执行,所以能做一些错误反馈页面
• __response.status和__response.send方法能多次使用,status会使用最后一次,send则是叠加,后面考虑写个获取和清空的api