阅读量:2
在Ubuntu中调试Swagger可按以下步骤操作:
-
安装基础环境
确保已安装Node.js和npm,若未安装可使用命令:sudo apt update sudo apt install -y nodejs npm -
安装Swagger工具
- 安装Swagger Editor(用于编写和调试API文档):
npm install -g swagger-editor-cli - 安装Swagger UI(用于接口测试):
npm install -g swagger-ui-express
- 安装Swagger Editor(用于编写和调试API文档):
-
配置Swagger
- 编辑Swagger Editor的
index.html文件,指定本地Swagger规范文件路径(如swagger.yaml/swagger.json)。 - 在Swagger UI中,通过输入框加载本地或远程的Swagger规范文件URL,点击“Explore”加载接口。
- 编辑Swagger Editor的
-
启动调试
- 启动Swagger Editor:进入项目目录,运行
npm start,默认在端口3000运行,可通过浏览器访问http://localhost:3000。 - 启动Swagger UI:若通过Express集成,运行
node app.js,访问http://localhost:3000/api-docs。
- 启动Swagger Editor:进入项目目录,运行
-
接口测试与调试
- 在Swagger Editor中直接调用接口测试,或通过Swagger UI的“Try it out!”按钮输入参数测试。
- 若需高级调试,可在Visual Studio Code中配置
launch.json,通过node --inspect-brk app.js启动调试模式,设置断点查看变量和执行流程。
-
常见问题处理
- 防火墙拦截:若无法访问,检查防火墙规则,允许对应端口(如
sudo ufw allow 3000)。 - 配置文件错误:确保
swagger-config.yaml路径正确,或直接编辑swagger.json/swagger.yaml文件。
- 防火墙拦截:若无法访问,检查防火墙规则,允许对应端口(如
参考来源:
以上就是关于“Ubuntu中Swagger如何调试”的相关介绍,筋斗云是国内较早的云主机应用的服务商,拥有10余年行业经验,提供丰富的云服务器、租用服务器等相关产品服务。云服务器资源弹性伸缩,主机vCPU、内存性能强悍、超高I/O速度、故障秒级恢复;电子化备案,提交快速,专业团队7×24小时服务支持!
简单好用、高性价比云服务器租用链接:https://www.jindouyun.cn/product/cvm