YurunDoc 插件接口列表
目录
[TOC]
简介
所有事件的方法参数都是一个数组array,下面文档中所写参数都是数组中的键。
事件列表
CROSS_ECHO_CONTENT_BEFORE
跨域接口代理输出结果前事件。
参数:
| 名称 | 描述 | 可修改 |
|---|---|---|
| handler | Cross类实例 | √ |
| response | 待输出内容 | √ |
CROSS_GET_URL
跨域接口代理获取请求地址前事件。
参数:
| 名称 | 描述 | 可修改 |
|---|---|---|
| handler | Cross类实例 | √ |
| url | 获取或设置的url | √ |
CROSS_GET_HEADERS
跨域接口代理获取请求头前事件。
参数:
| 名称 | 描述 | 可修改 |
|---|---|---|
| handler | Cross类实例 | √ |
| headers | 获取或设置的headers | √ |
CROSS_GET_REQUEST_BODY
跨域接口代理获取请求主体前事件。
参数:
| 名称 | 描述 | 可修改 |
|---|---|---|
| handler | Cross类实例 | √ |
| requestBody | 获取或设置的requestBody | √ |
CROSS_GET_METHOD
跨域接口代理获取请求方法前事件。
参数:
| 名称 | 描述 | 可修改 |
|---|---|---|
| handler | Cross类实例 | √ |
| method | 获取或设置的method | √ |
BATCH_CHECK_ORIGIN
检查跨域事件。
参数:
| 名称 | 描述 | 可修改 |
|---|---|---|
| handler | Batch类实例 | √ |
BATCH_BEFORE_SEND
批量请求发送前事件,每一个接口请求前都会触发
参数:
| 名称 | 描述 | 可修改 |
|---|---|---|
| handler | Batch类实例 | √ |
| method | 获取或设置的method | √ |
| getDataType | 获取或设置的getDataType | √ |
| bodyDataType | 获取或设置的bodyDataType | √ |
| url | 获取或设置的url | √ |
| postData | 获取或设置的postData | √ |
BATCH_ECHO_CONTENT_BEFORE
批量请求处理完成后,返回结果前事件。
事件中可通过$data['handler']->result修改返回结果。
参数:
| 名称 | 描述 | 可修改 |
|---|---|---|
| handler | Batch类实例 | √ |