M2LOrder开发者指南:Swagger文档/API调试/错误排查全流程详解
1. 概述
M2LOrder是一个基于.opt模型文件的情绪识别与情感分析服务,提供HTTP API和WebUI两种访问方式。本文将详细介绍如何使用Swagger文档进行API调试,以及常见问题的排查方法。
2. 服务基础信息
2.1 服务配置
| 项目 | 值 |
|---|---|
| 项目路径 | /root/m2lorder |
| 模型目录 | /root/ai-models/buffing6517/m2lorder |
| API端口 | 8001 |
| WebUI端口 | 7861 |
2.2 访问地址
| 服务 | URL | 说明 |
|---|---|---|
| WebUI | http://[服务器IP]:7861 | 图形化界面 |
| API | http://[服务器IP]:8001 | RESTful API |
| API文档 | http://[服务器IP]:8001/docs | Swagger文档 |
3. Swagger文档使用指南
3.1 访问Swagger UI
- 在浏览器中打开
http://[服务器IP]:8001/docs - 页面将显示所有可用的API端点
- 每个端点都有详细说明和参数描述
3.2 接口测试方法
- 点击要测试的端点
- 点击"Try it out"按钮
- 填写请求参数
- 点击"Execute"发送请求
- 查看服务器响应和状态码
3.3 主要API端点说明
3.3.1 健康检查
GET /health用于检查服务是否正常运行,返回服务状态信息。
3.3.2 模型管理
GET /models # 获取所有模型列表 GET /models/{id} # 获取特定模型详情3.3.3 情感预测
POST /predict # 单条文本预测 POST /predict/batch # 批量文本预测4. API调试实战
4.1 使用cURL测试API
健康检查测试
curl http://[服务器IP]:8001/health情感预测测试
curl -X POST http://[服务器IP]:8001/predict \ -H "Content-Type: application/json" \ -d '{ "model_id": "A001", "input_data": "I'm feeling great today!" }'4.2 使用Postman测试API
- 新建请求,选择POST方法
- 输入URL:
http://[服务器IP]:8001/predict - 设置Headers:
Content-Type: application/json - 在Body中输入JSON格式请求数据
- 点击Send发送请求
5. 常见错误排查
5.1 连接问题
症状:无法连接到API服务
解决方案:
- 检查服务是否运行:
ps aux | grep uvicorn - 检查端口是否开放:
netstat -tulnp | grep 8001 - 检查防火墙设置
5.2 模型加载失败
症状:API返回模型加载错误
解决方案:
- 检查模型文件是否存在
- 验证模型文件权限
- 检查模型目录配置
5.3 性能问题
症状:响应时间过长
解决方案:
- 使用更小的模型(如A001-A012系列)
- 检查服务器资源使用情况
- 考虑增加服务实例
6. 日志分析
6.1 日志文件位置
| 服务 | 日志路径 |
|---|---|
| API | /root/m2lorder/logs/supervisor/api.log |
| WebUI | /root/m2lorder/logs/supervisor/webui.log |
6.2 常见日志信息解读
- 启动成功:
Application startup complete - 模型加载:
Loading model: [模型ID] - 请求处理:
Processing request from [IP] - 错误信息:通常包含
ERROR关键字和详细描述
7. 总结
本文详细介绍了M2LOrder服务的API调试和错误排查全流程。通过Swagger文档可以方便地了解和测试API接口,而系统的日志和监控机制则能帮助快速定位和解决问题。
获取更多AI镜像
想探索更多AI镜像和应用场景?访问 CSDN星图镜像广场,提供丰富的预置镜像,覆盖大模型推理、图像生成、视频生成、模型微调等多个领域,支持一键部署。