Skip to content

Commit

Permalink
Update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Aug 23, 2024
1 parent 83edfc3 commit cc54e02
Show file tree
Hide file tree
Showing 4 changed files with 211 additions and 28 deletions.
21 changes: 21 additions & 0 deletions docs/api/db.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ YAKIT_PLUGIN_TYPE_YAK|(string) "yak"|
| [db.SaveHTTPFlowFromRaw](#savehttpflowfromraw) ||
| [db.SaveHTTPFlowFromRawWithOption](#savehttpflowfromrawwithoption) ||
| [db.SaveHTTPFlowFromRawWithType](#savehttpflowfromrawwithtype) ||
| [db.SaveHTTPFlowInstance](#savehttpflowinstance) ||
| [db.SavePayload](#savepayload) ||
| [db.SavePayloadByFile](#savepayloadbyfile) ||
| [db.SavePortFromResult](#saveportfromresult) ||
Expand Down Expand Up @@ -737,6 +738,26 @@ YAKIT_PLUGIN_TYPE_YAK|(string) "yak"|
| r1 | `error` | |


### SaveHTTPFlowInstance

#### 详细描述


#### 定义

`SaveHTTPFlowInstance(flow *schema.HTTPFlow) error`

#### 参数
|参数名|参数类型|参数解释|
|:-----------|:---------- |:-----------|
| flow | `*schema.HTTPFlow` | |

#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
|:-----------|:---------- |:-----------|
| r1 | `error` | |


### SavePayload

#### 详细描述
Expand Down
156 changes: 133 additions & 23 deletions docs/api/exec.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,34 @@

|函数名|函数描述/介绍|
|:------|:--------|
| [exec.CheckCrash](#checkcrash) ||
| [exec.Command](#command) ||
| [exec.CommandContext](#commandcontext) ||
| [exec.System](#system) ||
| [exec.SystemBatch](#systembatch) ||
| [exec.SystemContext](#systemcontext) |执行系统命令 |
| [exec.WatchOutput](#watchoutput) ||
| [exec.WatchStderr](#watchstderr) ||
| [exec.WatchStdout](#watchstdout) ||
| [exec.callback](#callback) ||
| [exec.concurrent](#concurrent) ||
| [exec.timeout](#timeout) ||
| [exec.CheckCrash](#checkcrash) |CheckCrash 检查命令执行是否发生了崩溃，不支持 Windows 系统，返回值为是否崩溃和错误信息 |
| [exec.Command](#command) |Command 创建一个命令结构体 |
| [exec.CommandContext](#commandcontext) |CommandContext 创建一个受上下文控制的命令结构体，其第一个参数是上下文，第二个参数是要执行的命令 |
| [exec.System](#system) |System 创建命令结构体并执行，返回结果与错误 |
| [exec.SystemBatch](#systembatch) |SystemBatch 批量执行命令，它的第一个参数为要批量执行的命令(支持 fuzztag )，接下来可以接收零个到多个选项，用于对批量命令执行进行配置，例如设置超时时间，回调函数等 |
| [exec.SystemContext](#systemcontext) |SystemContext 创建受上下文控制的命令结构体并执行，返回结果与错误 |
| [exec.WatchOutput](#watchoutput) |WatchStdout 执行命令并监控标准输出，当标准输出有数据时，会调用回调函数处理数据，回调函数的参数为标准输出的原始数据，返回值为是否继续监控 |
| [exec.WatchStderr](#watchstderr) |WatchStderr 执行命令并监控标准错误，当标准错误有数据时，会调用回调函数处理数据，回调函数的参数为标准错误的原始数据，返回值为是否继续监控 |
| [exec.WatchStdout](#watchstdout) |WatchStdout 执行命令并监控标准输出，当标准输出有数据时，会调用回调函数处理数据，回调函数的参数为标准输出的原始数据，返回值为是否继续监控 |
| [exec.callback](#callback) |callback 是一个选项参数，用于设置批量命令执行的回调函数，回调函数的第一个参数为执行的命令，第二个参数为执行的结果，在回调函数中可以对命令执行结果进行处理 |
| [exec.concurrent](#concurrent) |concurrent 是一个选项参数，用于设置批量命令执行的并发数，默认为 20 |
| [exec.timeout](#timeout) |timeout 是一个选项参数，用于设置批量命令执行的超时时间，单位为秒 |


## 函数定义
### CheckCrash

#### 详细描述
CheckCrash 检查命令执行是否发生了崩溃，不支持 Windows 系统，返回值为是否崩溃和错误信息

Example:
```
cmd = exec.Command("ls -al")~
isCrash = exec.CheckCrash(cmd)~
if isCrash {
// ...
}
```


#### 定义
Expand All @@ -41,16 +51,24 @@
### Command

#### 详细描述
Command 创建一个命令结构体

Example:
```
cmd = exec.Command("ls -al")
output = cmd.CombineOutput()~
dump(output)
```


#### 定义

`Command(i string) (*exec.Cmd, error)`
`Command(s string) (*exec.Cmd, error)`

#### 参数
|参数名|参数类型|参数解释|
|:-----------|:---------- |:-----------|
| i | `string` | |
| s | `string` | |

#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
Expand All @@ -62,6 +80,14 @@
### CommandContext

#### 详细描述
CommandContext 创建一个受上下文控制的命令结构体，其第一个参数是上下文，第二个参数是要执行的命令

Example:
```
cmd = exec.CommandContext(context.New(), "ls -al")
output = cmd.CombineOutput()~
dump(output)
```


#### 定义
Expand All @@ -84,6 +110,13 @@
### System

#### 详细描述
System 创建命令结构体并执行，返回结果与错误

Example:
```
output, err = exec.System("ls -al")~
dump(output)
```


#### 定义
Expand All @@ -105,23 +138,40 @@
### SystemBatch

#### 详细描述
SystemBatch 批量执行命令，它的第一个参数为要批量执行的命令(支持 fuzztag )，接下来可以接收零个到多个选项，用于对批量命令执行进行配置，例如设置超时时间，回调函数等

Example:
```
exec.SystemBatch("ping 192.168.1.{{int(1-100)}}",
exec.timeout(10),
exec.concurrent(20),
exec.callback(func(cmd, result) {
log.Infof("exec[%v] result: %v", cmd, string(result))
})
```


#### 定义

`SystemBatch(i string, opts ...poolOpt)`
`SystemBatch(i string, opts ...execPoolOpt)`

#### 参数
|参数名|参数类型|参数解释|
|:-----------|:---------- |:-----------|
| i | `string` | |
| opts | `...poolOpt` | |
| opts | `...execPoolOpt` | |


### SystemContext

#### 详细描述
执行系统命令
SystemContext 创建受上下文控制的命令结构体并执行，返回结果与错误

Example:
```
output, err = exec.SystemContext(context.New(),"ls -al")~
dump(output)
```


#### 定义
Expand All @@ -144,6 +194,15 @@
### WatchOutput

#### 详细描述
WatchStdout 执行命令并监控标准输出，当标准输出有数据时，会调用回调函数处理数据，回调函数的参数为标准输出的原始数据，返回值为是否继续监控

Example:
```
exec.WatchStdout("tail -f /tmp/log", 60, func(raw) {
log.Infof("stdout: %v", string(raw))
return true
}
```


#### 定义
Expand All @@ -166,6 +225,15 @@
### WatchStderr

#### 详细描述
WatchStderr 执行命令并监控标准错误，当标准错误有数据时，会调用回调函数处理数据，回调函数的参数为标准错误的原始数据，返回值为是否继续监控

Example:
```
exec.WatchStderr("tail -f /tmp/log", 60, func(raw) {
log.Infof("stderr: %v", string(raw))
return true
}
```


#### 定义
Expand All @@ -188,6 +256,15 @@
### WatchStdout

#### 详细描述
WatchStdout 执行命令并监控标准输出，当标准输出有数据时，会调用回调函数处理数据，回调函数的参数为标准输出的原始数据，返回值为是否继续监控

Example:
```
exec.WatchStdout("tail -f /tmp/log", 60, func(raw) {
log.Infof("stdout: %v", string(raw))
return true
}
```


#### 定义
Expand All @@ -210,11 +287,22 @@
### callback

#### 详细描述
callback 是一个选项参数，用于设置批量命令执行的回调函数，回调函数的第一个参数为执行的命令，第二个参数为执行的结果，在回调函数中可以对命令执行结果进行处理

Example:
```
exec.SystemBatch("ping 192.168.1.{{int(1-100)}}",
exec.timeout(10),
exec.concurrent(20),
exec.callback(func(cmd, result) {
log.Infof("exec[%v] result: %v", cmd, string(result))
})
```


#### 定义

`callback(f func(string, []byte)) poolOpt`
`callback(f func(string, []byte)) execPoolOpt`

#### 参数
|参数名|参数类型|参数解释|
Expand All @@ -224,17 +312,28 @@
#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
|:-----------|:---------- |:-----------|
| r1 | `poolOpt` | |
| r1 | `execPoolOpt` | |


### concurrent

#### 详细描述
concurrent 是一个选项参数，用于设置批量命令执行的并发数，默认为 20

Example:
```
exec.SystemBatch("ping 192.168.1.{{int(1-100)}}",
exec.timeout(10),
exec.concurrent(20),
exec.callback(func(cmd, result) {
log.Infof("exec[%v] result: %v", cmd, string(result))
})
```


#### 定义

`concurrent(i int) poolOpt`
`concurrent(i int) execPoolOpt`

#### 参数
|参数名|参数类型|参数解释|
Expand All @@ -244,17 +343,28 @@
#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
|:-----------|:---------- |:-----------|
| r1 | `poolOpt` | |
| r1 | `execPoolOpt` | |


### timeout

#### 详细描述
timeout 是一个选项参数，用于设置批量命令执行的超时时间，单位为秒

Example:
```
exec.SystemBatch("ping 192.168.1.{{int(1-100)}}",
exec.timeout(10),
exec.concurrent(20),
exec.callback(func(cmd, result) {
log.Infof("exec[%v] result: %v", cmd, string(result))
})
```


#### 定义

`timeout(i float64) poolOpt`
`timeout(i float64) execPoolOpt`

#### 参数
|参数名|参数类型|参数解释|
Expand All @@ -264,6 +374,6 @@
#### 返回值
|返回值(顺序)|返回值类型|返回值解释|
|:-----------|:---------- |:-----------|
| r1 | `poolOpt` | |
| r1 | `execPoolOpt` | |


2 changes: 1 addition & 1 deletion docs/api/simulator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ htmlChangeMode|(simulator.loginDetectMode) 1|
leaklessDefault|(simulator.LeaklessMode) 0|
leaklessOff|(simulator.LeaklessMode) -1|
leaklessOn|(simulator.LeaklessMode) 1|
simple|(map[string]interface {}) map[string]interface {}{"bodyModifyTarget": "body", "bodyReplaceTarget": "bodyReplace", "createBrowser": (func(...simple.BrowserConfigOpt) *simple.VBrowser)(0x270ad00), "headersModifyTarget": "headers", "headless": (func(bool) simple.BrowserConfigOpt)(0x270a740), "hostModifyTarget": "host", "noSandBox": (func(bool) simple.BrowserConfigOpt)(0x270a6c0), "proxy": (func(string, ...string) simple.BrowserConfigOpt)(0x270a500), "requestModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x270aa60), "responseModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x270a7c0), "wsAddress": (func(string) simple.BrowserConfigOpt)(0x270a420)}|
simple|(map[string]interface {}) map[string]interface {}{"bodyModifyTarget": "body", "bodyReplaceTarget": "bodyReplace", "createBrowser": (func(...simple.BrowserConfigOpt) *simple.VBrowser)(0x2709440), "headersModifyTarget": "headers", "headless": (func(bool) simple.BrowserConfigOpt)(0x2708e80), "hostModifyTarget": "host", "noSandBox": (func(bool) simple.BrowserConfigOpt)(0x2708e00), "proxy": (func(string, ...string) simple.BrowserConfigOpt)(0x2708c40), "requestModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x27091a0), "responseModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x2708f00), "wsAddress": (func(string) simple.BrowserConfigOpt)(0x2708b60)}|
urlChangeMode|(simulator.loginDetectMode) 0|

|函数名|函数描述/介绍|
Expand Down
Loading

0 comments on commit cc54e02

Please sign in to comment.