Super-frpc/backend
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

docs(api): update field names to use camelCase in API documentation

Browse Source
This commit is contained in:
NanamiAdmin
2026-03-23 22:14:04 +08:00
parent a3b8d59344
commit e335ce4da6
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api.md
+9 -9
View File
@@ -826,16 +826,16 @@ X-Timestamp: 1704067200000
{ {
"name": "ssh_proxy", "name": "ssh_proxy",
"type": "tcp", "type": "tcp",
"local_ip": "127.0.0.1", "localIP": "127.0.0.1",
"local_port": "22", "localPort": "22",
"remote_port": "6000" "remotePort": "6000"
}, },
{ {
"name": "web_proxy", "name": "web_proxy",
"type": "http", "type": "http",
"local_ip": "127.0.0.1", "localIP": "127.0.0.1",
"local_port": "8080", "localPort": "8080",
"remote_port": "80" "remotePort": "80"
} }
] ]
} }
@@ -854,9 +854,9 @@ X-Timestamp: 1704067200000
|-------|------|-------------| |-------|------|-------------|
| name | string | Proxy name | | name | string | Proxy name |
| type | string | Proxy type (e.g., tcp, udp, http, https) | | type | string | Proxy type (e.g., tcp, udp, http, https) |
| local_ip | string | Local IP address to forward to | | localIP | string | Local IP address to forward to |
| local_port | string | Local port to forward from | | localPort | string | Local port to forward from |
| remote_port | string | Remote port on frps to expose | | remotePort | string | Remote port on frps to expose |
> **Note:** > **Note:**
> - The proxy configurations are read from the existing config file > - The proxy configurations are read from the existing config file