mirror of
https://github.com/weiaiweiai/NezhaAgentHTTPBridge.git
synced 2026-05-13 21:49:09 +08:00
更新 README.md 以添加 NezhaAgentHTTPBridge 说明
添加了关于 NezhaAgentHTTPBridge 的功能、使用方法、API 接口、注意事项、错误代码及许可证信息的详细说明。内容涵盖了如何通过 HTTP 接口与 WebSocket 进行交互,并提供了相关的使用指导。
This commit is contained in:
47
README.md
Normal file
47
README.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
# NezhaAgentHTTPBridge
|
||||||
|
|
||||||
|
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Žӣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> / <20>ۺ<EFBFBD><DBBA><EFBFBD><EFBFBD><EFBFBD> WebSocket <20><><EFBFBD>͵ķ<CDB5><C4B7><EFBFBD><EFBFBD><EFBFBD>״̬<D7B4><CCAC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>һ<EFBFBD><D2BB><EFBFBD><EFBFBD><EFBFBD>ṩ HTTP <20>ӿ<EFBFBD> `/WeatherForecast/lastws` <20><>ǰ<EFBFBD><C7B0><EFBFBD><EFBFBD>ѯ<EFBFBD><D1AF><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ǰ<EFBFBD><C7B0>չʾҳ `UI.html`<EFBFBD><EFBFBD>
|
||||||
|
|
||||||
|
## <20><><EFBFBD><EFBFBD>ʹ<EFBFBD><CAB9>
|
||||||
|
1. <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ˣ<EFBFBD><CBA3>ָ<EFBFBD><D6B8><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>У<EFBFBD><D0A3><EFBFBD>
|
||||||
|
2. ʵ<>ֻ<EFBFBD><D6BB><EFBFBD><EFBFBD><EFBFBD> WebSocket <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><DFBC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD><C2BC><EFBFBD> JSON д<><D0B4> `WebSocketMessageStore`<EFBFBD><EFBFBD>
|
||||||
|
3. <20><><EFBFBD><EFBFBD>/<2F><><EFBFBD><EFBFBD> `UI.html`<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> `CFG.api` <20><>Ϊ<EFBFBD><CEAA><EFBFBD><EFBFBD>ʵ<EFBFBD>ʵ<EFBFBD>ַ<EFBFBD><D6B7>
|
||||||
|
4. ǰ<>˿<EFBFBD>ʼ<EFBFBD><CABC>ѯ<EFBFBD><D1AF>ʾ<EFBFBD>ڵ<EFBFBD>״̬<D7B4><CCAC>
|
||||||
|
|
||||||
|
## <20>ӿ<EFBFBD>
|
||||||
|
- ·<><C2B7><EFBFBD><EFBFBD>`/WeatherForecast/lastws`
|
||||||
|
- <20><><EFBFBD>ã<EFBFBD><C3A3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>һ<EFBFBD><D2BB> WebSocket <20><><EFBFBD><EFBFBD>ԭʼ JSON<4F><4E><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ݷ<EFBFBD><DDB7><EFBFBD> 404<30><34>
|
||||||
|
- ֧<>ֵ<EFBFBD><D6B5><EFBFBD><EFBFBD><EFBFBD> (`state + host`) <20><><EFBFBD><EFBFBD><EFBFBD>㺬 `servers` / `list` / `data` <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ṹ<EFBFBD><E1B9B9>
|
||||||
|
|
||||||
|
## ʹ<><CAB9>ʱע<CAB1><D7A2>
|
||||||
|
- <20><>ַͬ<D6B7><CDAC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>·<EFBFBD>ɻ<EFBFBD><C9BB><EFBFBD><EFBFBD>õ<EFBFBD><C3B5><EFBFBD>·<EFBFBD><C2B7>ʱ<EFBFBD><CAB1>ͬ<EFBFBD><CDAC><EFBFBD><EFBFBD>ǰ<EFBFBD><C7B0> `CFG.api`<EFBFBD><EFBFBD>
|
||||||
|
- <20><>ַ<EFBFBD>ģ<DEB8><C4A3><EFBFBD><EFBFBD><EFBFBD>`WebSocketClientBackgroundService`<EFBFBD>е<EFBFBD> WebSocket <20><>ַ<EFBFBD><D6B7>
|
||||||
|
- HTTPS<50><53>ҳ<EFBFBD><D2B3>Ϊ https <20><><EFBFBD><EFBFBD>ʹ<EFBFBD><CAB9> https <20>ӿڣ<D3BF><DAA3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ء<EFBFBD>
|
||||||
|
- CORS<52><53><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ں<EFBFBD><DABA><EFBFBD><EFBFBD><EFBFBD>ʽ<EFBFBD><CABD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Դ<EFBFBD><D4B4><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ȫ<EFBFBD><C8AB><EFBFBD>š<EFBFBD>
|
||||||
|
- <20><><EFBFBD><EFBFBD><EFBFBD>ж<EFBFBD><D0B6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> `last_active` <20><> `offlineSec`<EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ñ<EFBFBD> ISO8601 / UTC<54><43>
|
||||||
|
- CPU <20><>ֵ<EFBFBD><D6B5>ǰ<EFBFBD>˼ٶ<CBBC><D9B6><EFBFBD>Χ 0<>C100<30><30><EFBFBD><EFBFBD>ԭʼΪ 0<>C1 <20><><EFBFBD>Ȼ<EFBFBD><C8BB>㡣
|
||||||
|
- <20>ֶ<EFBFBD><D6B6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ȱʧ `state.*` <20><> `host.*` <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>쳣<EFBFBD><ECB3A3><EFBFBD><EFBFBD>ʾ<EFBFBD><CABE>
|
||||||
|
- <20><>ѯƵ<D1AF>ʣ<EFBFBD>Ĭ<EFBFBD><C4AC> 3000ms<6D><73><EFBFBD>ڵ<EFBFBD><DAB5><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ӿ<EFBFBD>ѹ<EFBFBD><D1B9><EFBFBD><EFBFBD>ʱ<EFBFBD><CAB1><EFBFBD>Ӽ<EFBFBD><D3BC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><>2000ms<6D><73><EFBFBD><EFBFBD>
|
||||||
|
- <20><>ȫ<EFBFBD><C8AB><EFBFBD>ƣ<EFBFBD><C6A3><EFBFBD>Ҫʱ<D2AA><CAB1><EFBFBD>ӷ<EFBFBD><D3B7><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> / Header Token / <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʲ<EFBFBD><CAB2>ԡ<EFBFBD>
|
||||||
|
- <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ݣ<EFBFBD><DDA3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ڲ<EFBFBD> IP / <20><><EFBFBD>ˣ<EFBFBD><CBA3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ֱ<EFBFBD>ӹ<EFBFBD><D3B9><EFBFBD><EFBFBD><EFBFBD>¶<EFBFBD><C2B6>
|
||||||
|
- <20><>չ<EFBFBD><D5B9><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
||||||
|
- <20><><EFBFBD>ڵ㣺ʹ<E3A3BA><CAB9><EFBFBD>ֵ䰴Ψһ ID <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>״̬
|
||||||
|
- <20><>ʷ<EFBFBD><CAB7><EFBFBD>ߣ<EFBFBD><DFA3><EFBFBD><EFBFBD>̻<EFBFBD><CCBB><EFBFBD><EFBFBD>λ<EFBFBD><CEBB><EFBFBD><EFBFBD>洢ʱ<E6B4A2><CAB1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
||||||
|
- Prometheus<75><73>ת<EFBFBD><D7AA><EFBFBD>ֶε<D6B6><CEB5><EFBFBD>ָ<EFBFBD><D6B8>
|
||||||
|
- <20><>ȡת<C8A1>ƣ<EFBFBD><C6A3>ɸ<EFBFBD><C9B8><EFBFBD> SSE / WebSocket <20><><EFBFBD>м<EFBFBD><D0BC><EFBFBD><EFBFBD><EFBFBD>ѯ
|
||||||
|
- <20>ֶ<EFBFBD>ӳ<EFBFBD>䣺<EFBFBD><E4A3BA><EFBFBD><EFBFBD>ͳһ<CDB3>淶<EFBFBD>㣬<EFBFBD><E3A3AC><EFBFBD>ݲ<EFBFBD>ͬ<EFBFBD><CDAC><EFBFBD>θ<EFBFBD>ʽ
|
||||||
|
|
||||||
|
## <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
||||||
|
| <20><><EFBFBD><EFBFBD> | <20><><EFBFBD><EFBFBD> |
|
||||||
|
|------|------|
|
||||||
|
| 404 | <20><>δд<CEB4><D0B4><EFBFBD>κ<EFBFBD> WebSocket <20><><EFBFBD>ݻ<EFBFBD>·<EFBFBD>ɲ<EFBFBD><C9B2><EFBFBD>ȷ |
|
||||||
|
| <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ݡ<EFBFBD> | <20><><EFBFBD>黺<EFBFBD><E9BBBA>д<EFBFBD><D0B4><EFBFBD><EFBFBD><DFBC><EFBFBD><EFBFBD>ӿڷ<D3BF><DAB7><EFBFBD><EFBFBD><EFBFBD> |
|
||||||
|
| CORS <20><><EFBFBD><EFBFBD> | <20><><EFBFBD><EFBFBD>δ<EFBFBD><CEB4><EFBFBD>ж<EFBFBD>Ӧ Origin |
|
||||||
|
| <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> | ʱ<><CAB1><EFBFBD><EFBFBD>ʽ<EFBFBD><CABD><EFBFBD>ɽ<EFBFBD><C9BD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʱ<EFBFBD><CAB1>Ư<EFBFBD><C6AF> |
|
||||||
|
| CPU/<2F>ڴ<EFBFBD><DAB4><EFBFBD>ʾ<EFBFBD>쳣 | δͳһ<CDB3><D2BB>λ/<2F>ٷֱȻ<D6B1><C8BB><EFBFBD> |
|
||||||
|
|
||||||
|
## <20><><EFBFBD><EFBFBD>
|
||||||
|
<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʹ<EFBFBD><EFBFBD> MIT<49><54><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> LICENSE<53><45><EFBFBD><EFBFBD>
|
||||||
|
|
||||||
|
## <20><>л
|
||||||
|
<EFBFBD><EFBFBD>߸̽<EFBFBD>뼰<EFBFBD><EFBFBD><EFBFBD>ؿ<EFBFBD>Դ<EFBFBD><EFBFBD>̬<EFBFBD><EFBFBD>
|
||||||
Reference in New Issue
Block a user