Ubuntu中Swagger如何调试

在Ubuntu中调试Swagger可按以下步骤操作：

1. 安装基础环境
   确保已安装Node.js和npm，若未安装可使用命令：

   sudo apt update  
   sudo apt install -y nodejs npm  
   

2. 安装Swagger工具

   • 安装Swagger Editor（用于编写和调试API文档）：

     npm install -g swagger-editor-cli  
     

   • 安装Swagger UI（用于接口测试）：

     npm install -g swagger-ui-express  
     

3. 配置Swagger

   • 编辑Swagger Editor的index.html文件，指定本地Swagger规范文件路径（如swagger.yaml/swagger.json）。
   • 在Swagger UI中，通过输入框加载本地或远程的Swagger规范文件URL，点击“Explore”加载接口。

4. 启动调试

   • 启动Swagger Editor：进入项目目录，运行npm start，默认在端口3000运行，可通过浏览器访问http://localhost:3000。
   • 启动Swagger UI：若通过Express集成，运行node app.js，访问http://localhost:3000/api-docs。

5. 接口测试与调试

   • 在Swagger Editor中直接调用接口测试，或通过Swagger UI的“Try it out!”按钮输入参数测试。
   • 若需高级调试，可在Visual Studio Code中配置launch.json，通过node --inspect-brk app.js启动调试模式，设置断点查看变量和执行流程。

6. 常见问题处理

   • 防火墙拦截：若无法访问，检查防火墙规则，允许对应端口（如sudo ufw allow 3000）。
   • 配置文件错误：确保swagger-config.yaml路径正确，或直接编辑swagger.json/swagger.yaml文件。

参考来源：