Send mouse wheel scroll events
版本新增:v1.102
接口:POST /api/hid/events/send_mouse_wheel
发送鼠标滚轮滚动事件,支持水平和垂直方向滚动。
### 多版本文档维护
通过Git子模块或条件包含实现多版本文档共存:
1. 在`docs/versions`目录下使用Git子模块关联不同版本标签:
```bash
git submodule add -b v1.102 https://gitcode.com/gh_mirrors/pi/pikvm.git docs/versions/v1.102
- 在
mkdocs.yml中配置版本选择器:
nav:
- 最新版本: index.md
- 历史版本:
- v1.102: versions/v1.102/docs/api.md
- v1.101: versions/v1.101/docs/api.md
自动化版本管理
API版本检测
通过脚本自动提取API版本并创建Git标签:
import requests
import re
# 获取当前API版本
response = requests.get("https://<pikvm-ip>/api/info", verify=False)
version = response.json()["result"]["system"]["kvmd"]["version"]
# 创建Git标签
import subprocess
subprocess.run(["git", "tag", f"v{version}"])
文档同步钩子
配置Git提交钩子(.git/hooks/pre-commit)检查API版本一致性:
#!/bin/sh
# 检查文档版本与代码版本是否一致
API_VERSION=$(grep -oP 'version": "\K[0-9.]+' docs/api.md)
KVMD_VERSION=$(grep -oP 'kvmd.version = "\K[0-9.]+' kvmd/apps/kvmd/__init__.py)
if [ "$API_VERSION" != "$KVMD_VERSION" ]; then
echo "错误:API文档版本与代码版本不一致"
exit 1
fi
版本控制最佳实践
兼容性处理
遵循以下原则确保API兼容性:
- 向后兼容:新增API功能时不修改现有接口
- 版本协商:在请求头中使用
Accept-Version指定API版本:
GET /api/hid HTTP/1.1
Accept-Version: 1.102
- 废弃标记:对即将移除的API添加明确标记:
### Set legacy parameters
> **废弃警告**:v1.102起已废弃,请使用`/api/hid/set_params`
> **替代接口**:`POST /api/hid/set_params`
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



