增加API注释

2025-11-25 04:10:55 +08:00 · 2023-06-17 21:05:03 +08:00
parent 6a7af9e5cd
commit 7d54f3e165
10 changed files with 116 additions and 25 deletions
--- a/pkg/rpc/jsons/reverse_proxy_ref.md
+++ b/pkg/rpc/jsons/reverse_proxy_ref.md
@@ -0,0 +1,19 @@
+# 反向代理引用
+## 定义
+~~~json
+{
+  "isOn": "是否启用",
+  "isPrior": "是否覆盖上级配置，用于路由规则",
+  "reverseProxyId": "反向代理ID"
+}
+~~~
+其中：
+* `reverseProxyId` - 反向代理ID，可以通过 `/ReverseProxyService/createReverseProxy` 创建
+
+## 示例
+~~~json
+{
+  "isOn": true,
+  "reverseProxyId": 123
+}
+~~~