TRKJ/EdgeCommon
2
0
Fork 0
mirror of https://github.com/TeaOSLab/EdgeCommon.git synced 2026-01-20 07:05:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

完善API注释

Browse Source
This commit is contained in:
刘祥超
2023-06-16 18:27:16 +08:00
parent 70bc6e7d8e
commit 6bf017ee22
12 changed files with 519 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
pkg/rpc/jsons/hsts.md Normal file
View File

@@ -0,0 +1,39 @@
# HSTS
## 定义
~~~json
{
"isOn": "是否启用",
"maxAge": "最大有效期，单位秒",
"includeSubDomains": "可选项，是否包含子域名",
"preload": "可选项，是否预加载",
"domains": ["可选项，支持的域名1", "可选项，支持的域名2" ...]
}
~~~
其中：
* `maxAge` 可以填写一天（86400秒）或者更长时间
* 如果不填写 `domains` 则支持所有域名
## 示例
### 不限制任何域名
~~~json
{
"isOn": true,
"maxAge": 86400,
"includeSubDomains":false,
"preload":false,
"domains":[]
}
~~~
### 限制域名
~~~json
{
"isOn": true,
"maxAge": 86400,
"includeSubDomains":false,
"preload":false,
"domains":["example.com", "www.example.com"]
}
~~~

49
pkg/rpc/jsons/http_protocol.md Normal file
View File

@@ -0,0 +1,49 @@
# HTTP协议配置
## 定义
~~~json
{
"isOn": "是否启用",
"listen": [
{
"protocol": "协议",
"host": "主机地址，通常为空",
"portRange": "端口或者端口范围"
},
...
]
}
~~~
## 示例
### 监听80端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "http",
"host": "",
"portRange": "80"
}
]
}
~~~
### 监听80和8080端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "http",
"portRange": "80"
},
{
"protocol": "http",
"portRange": "8080"
}
]
}
~~~

67
pkg/rpc/jsons/https_protocol.md Normal file
View File

@@ -0,0 +1,67 @@
# HTTPS协议配置
## 定义
~~~json
{
"isOn": "是否启用",
"listen": [
{
"protocol": "协议",
"host": "主机地址，通常为空",
"portRange": "端口或者端口范围"
},
...
],
"sslPolicyRef": {
"isOn": "启用SSL策略",
"sslPolicyId": "SSL策略ID"
}
}
~~~
其中 `SSL策略ID` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
## 示例
### 监听443端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "https",
"host": "",
"portRange": "443"
}
],
"sslPolicyRef": {
"isOn": true,
"sslPolicyId": 123
}
}
~~~
其中SSL策略ID `123` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
### 监听443和8443端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "https",
"portRange": "443"
},
{
"protocol": "https",
"portRange": "8443"
}
],
"sslPolicyRef": {
"isOn": true,
"sslPolicyId": 123
}
}
~~~
其中SSL策略ID `123` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。

19
pkg/rpc/jsons/ssl_cert_refs.md
View File

@@ -1,7 +1,24 @@
# SSL证书引用
## 示例
可以用来引用一组证书。
## 定义
~~~json
[
{
"isOn": "是否启用",
"certId": "证书ID 1"
},
{
"isOn": "是否启用",
"certId": "证书ID 2"
},
...
]
~~~
## 示例
~~~json
[
{
"isOn": true,

63
pkg/rpc/jsons/tcp_protocol.md Normal file
View File

@@ -0,0 +1,63 @@
# TCP协议配置
## 定义
~~~json
{
"isOn": "是否启用",
"listen": [
{
"protocol": "协议",
"host": "主机地址，通常为空",
"portRange": "端口或者端口范围"
},
...
]
}
~~~
## 示例
### 监听1234端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "tcp",
"host": "",
"portRange": "1234"
}
]
}
~~~
### 监听1234和2345端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "tcp",
"portRange": "1234"
},
{
"protocol": "tcp",
"portRange": "2345"
}
]
}
~~~
### 监听1234到1240之间的所有端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "tcp",
"host": "",
"portRange": "1234-1240"
}
]
}
~~~

68
pkg/rpc/jsons/tls_protocol.md Normal file
View File

@@ -0,0 +1,68 @@
# TLS协议配置
## 定义
~~~json
{
"isOn": "是否启用",
"listen": [
{
"protocol": "协议",
"host": "主机地址，通常为空",
"portRange": "端口或者端口范围"
},
...
],
"sslPolicyRef": {
"isOn": "启用SSL策略",
"sslPolicyId": "SSL策略ID"
}
}
~~~
其中 `SSL策略ID` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
## 示例
### 监听8443端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "tls",
"host": "",
"portRange": "8443"
}
],
"sslPolicyRef": {
"isOn": true,
"sslPolicyId": 123
}
}
~~~
其中SSL策略ID `123` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
### 监听8443和8543端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "tls",
"portRange": "8443"
},
{
"protocol": "tls",
"portRange": "8543"
}
],
"sslPolicyRef": {
"isOn": true,
"sslPolicyId": 123
}
}
~~~
其中SSL策略ID `123` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。

63
pkg/rpc/jsons/udp_protocol.md Normal file
View File

@@ -0,0 +1,63 @@
# UDP协议配置
## 定义
~~~json
{
"isOn": "是否启用",
"listen": [
{
"protocol": "协议",
"host": "主机地址，通常为空",
"portRange": "端口或者端口范围"
},
...
]
}
~~~
## 示例
### 监听1234端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "udp",
"host": "",
"portRange": "1234"
}
]
}
~~~
### 监听1234和2345端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "udp",
"portRange": "1234"
},
{
"protocol": "udp",
"portRange": "2345"
}
]
}
~~~
### 监听1234到1240之间的所有端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "udp",
"host": "",
"portRange": "1234-1240"
}
]
}
~~~