后端 hookList

目前 hooksList 只有下面列出的部分，如果您有其他的需求，可提建议到 github 或者 qq 群

  1. /**
  2.  * 钩子配置
  3.  */
  4. var hooks = {
  5.     /**
  6.      * 第三方sso登录钩子，暂只支持设置一个
  7.      * @param ctx
  8.      * @return 必需返回一个 promise 对象，resolve({username: '', email: ''})
  9.      */
  10.     'third_login': {
  11.         type: 'single',
  12.         listener: null
  13.     },
  14.      /**
  15.    * 客户端增加接口成功后触发
  16.    * @param data 接口的详细信息
  17.    */
  18.     interface_add: {
  19.       type: 'multi',
  20.      listener: []
  21.     },
  22.     /**
  23.     * 客户端删除接口成功后触发
  24.      * @param data 删除接口的详细信息
  25.      */
  26.     interface_del: {
  27.      type: 'multi',
  28.      listener: []
  29.     },
  30.     /**
  31.      * 客户端更新接口成功后触发
  32.      * @param id 接口id
  33.     */
  34.     interface_update: {
  35.       type: 'multi',
  36.       listener: []
  37.     },
  38.     /**
  39.     * 客户端获取接口数据列表
  40.     * @param list 返回接口的数据列表
  41.     */
  42.     interface_list: {
  43.       type: 'multi',
  44.       listener: []
  45.     },
  46.     /**
  47.     * 客户端获取一条接口信息触发
  48.     * @param data 接口的详细信息
  49.     */
  50.     interface_get: {
  51.       type: 'multi',
  52.       listener: []
  53.     },
  54.     /**
  55.      * 客户端增加一个新项目
  56.      * @param id 项目id
  57.      */
  58.     'project_add':{
  59.         type: 'multi',
  60.         listener: []
  61.     },
  62.     /**
  63.      * 客户端删除删除一个项目
  64.      * @param id 项目id
  65.      */
  66.     'project_del':{
  67.         type: 'multi',
  68.         listener: []
  69.     },
  70.     /**
  71.      * MockServer生成mock数据后触发
  72.      * @param context Object
  73.      * {
  74.      *  projectData: project,
  75.         interfaceData: interfaceData,
  76.         ctx: ctx,
  77.         mockJson: res
  78.      * }
  79.      *
  80.      */
  81.     mock_after: {
  82.         type: 'multi',
  83.         listener: []
  84.     },
  85.     /**
  86.      * 增加路由的钩子
  87.      * type Sync
  88.      * @param addPluginRouter Function
  89.      * addPLuginPLugin(config)
  90.      * config = {
  91.      *  path,      // String
  92.      *  method,    // String
  93.      *  controller // Class 继承baseController的class
  94.      *  action     // String controller的Action
  95.      * }
  96.      */
  97.     add_router: {
  98.         type: 'multi',
  99.         listener: []
  100.     }
  101. };

前端 hookList

  1. /**
  2.  * type component  组件
  3.  *      listener   监听函数
  4.  * mulit 是否绑定多个监听函数
  5.  *
  6.  */
  8. hooks = {
  9.   /**
  10.    * 第三方登录 //可参考 yapi-plugin-qsso 插件
  11.    */
  12.   third_login: {
  13.     type: 'component',
  14.     mulit: false,
  15.     listener: null
  16.   },
  17.   /**
  18.    * 导入数据
  19.    * @param Object importDataModule
  20.    *
  21.    * @info
  22.    * 可参考 vendors/exts/yapi-plugin-import-swagger插件
  23.    * importDataModule = {};
  24.    *
  25.    */
  26.   import_data: {
  27.     type: 'listener',
  28.     mulit: true,
  29.     listener: []
  30.   },
  31.   /**
  32.    * 导出数据
  33.    * @param Object exportDataModule
  34.    * @param projectId
  35.    * @info
  36.    * exportDataModule = {};
  37.    * exportDataModule.pdf = {
  38.    *   name: 'Pdf',
  39.    *   route: '/api/plugin/export/pdf',
  40.    *   desc: '导出项目接口文档为 pdf 文件'
  41.    * }
  42.    */
  43.   export_data: {
  44.     type: 'listener',
  45.     mulit: true,
  46.     listener: []
  47.   },
  48.   /**
  49.    * 接口页面 tab 钩子
  50.    * @param InterfaceTabs
  51.    *
  52.    * @info
  53.    * 可参考 vendors/exts/yapi-plugin-advanced-mock
  54.    * let InterfaceTabs = {
  55.       view: {
  56.         component: View,
  57.         name: '预览'
  58.       },
  59.       edit: {
  60.         component: Edit,
  61.         name: '编辑'
  62.       },
  63.       run: {
  64.         component: Run,
  65.         name: '运行'
  66.       }
  67.     }
  68.    */
  69.   interface_tab: {
  70.     type: 'listener',
  71.     mulit: true,
  72.     listener: []
  73.   },
  74.   /**
  75.    * header下拉菜单 menu 钩子
  76.    * @param HeaderMenu
  77.    *
  78.    * @info
  79.    * 可参考 vendors/exts/yapi-plugin-statistics
  80.    * let HeaderMenu = {
  81.   user: {
  82.     path: '/user/profile',
  83.     name: '个人中心',
  84.     icon: 'user',
  85.     adminFlag: false
  86.   },
  87.   star: {
  88.     path: '/follow',
  89.     name: '我的关注',
  90.     icon: 'star-o',
  91.     adminFlag: false
  92.   },
  93.   solution: {
  94.     path: '/user/list',
  95.     name: '用户管理',
  96.     icon: 'solution',
  97.     adminFlag: true
  99.   },
  100.   logout: {
  101.     path: '',
  102.     name: '退出',
  103.     icon: 'logout',
  104.     adminFlag: false
  106.   }
  107. };
  108.    */
  109.   header_menu: {
  110.     type: 'listener',
  111.     mulit: true,
  112.     listener: []
  113.   },
  114.   /**
  115.    * Route路由列表钩子
  116.    * @param AppRoute
  117.    *
  118.    * @info
  119.    * 可参考 vendors/exts/yapi-plugin-statistics
  120.    * 添加位置在Application.js 中
  121.    * let AppRoute = {
  122.   home: {
  123.     path: '/',
  124.     component: Home
  125.   },
  126.   group: {
  127.     path: '/group',
  128.     component: Group
  129.   },
  130.   project: {
  131.     path: '/project/:id',
  132.     component: Project
  133.   },
  134.   user: {
  135.     path: '/user',
  136.     component: User
  137.   },
  138.   follow: {
  139.     path: '/follow',
  140.     component: Follows
  141.   },
  142.   addProject: {
  143.     path: '/add-project',
  144.     component: AddProject
  145.   },
  146.   login: {
  147.     path: '/login',
  148.     component: Login
  149.   }
  150. };
  151. };
  152.    */
  153.   app_route: {
  154.     type: 'listener',
  155.     mulit: true,
  156.     listener: []
  157.   },
  158.   /*
  159.    * 添加 reducer
  160.    * @param Object reducerModules
  161.    *
  162.    * @info
  163.    * importDataModule = {};
  164.    *
  165.    */
  167.   add_reducer: {
  168.     type: 'listener',
  169.     mulit: true,
  170.     listener: []
  171.   }
  172. };