1. 环境准备
- 系统要求:支持 Linux/macOS/Windows
- 依赖安装:
- Python 3.8+(推荐版本)
- 安装依赖包:
pip install -r requirements.txt
- 若需图形界面,确保已安装 支持库
2. 配置步骤
- 复制配置模板:
cp config.example.json config.json
- 修改配置文件,设置 API 密钥与端口(示例):
{ "api_key": "your_key_here", "port": 8080 }
- 启动服务:
python run.py
3. 验证安装
- 访问
http://localhost:8080
查看欢迎页面 - 使用 curl 测试接口:
预期响应:curl -X GET http://localhost:8080/status
{"status": "success", "version": "1.0.0"}
4. 常见问题
- Q: 安装失败如何排查?
A: 参考 故障排查手册
提示:如需进一步了解使用方法,请访问 API 工具使用指南。