
本文介绍在Linux系统下调试Swagger的步骤。
一、安装Swagger UI和Swagger Editor
首先,需要安装Swagger UI和Swagger Editor。推荐使用Docker安装Swagger UI,方便快捷。
-
安装Swagger UI (Docker): 执行以下命令拉取并运行Swagger UI镜像:
docker pull swaggerapi/swagger-ui:v4.15.5 docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5
这将启动一个Swagger UI容器,并将其8080端口映射到主机的38081端口。
-
安装Swagger Editor (手动): Swagger Editor需要手动下载静态文件,并配置Web服务器。 使用以下命令下载:
wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.js wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.css
将下载的文件放置到Web服务器的目录下(例如
/var/www/html),并配置服务器(Apache或Nginx)使其可访问。
二、Swagger配置
接下来,需要配置Swagger UI指向你的API文档。
系统优势: 全DIV+CSS模板,多浏览器适应,完美兼容IE6-IE8,以及Firefox Opera 等符合标准的浏览器,模板样式集中在一个CSS文件中,内容与样式完全分离,方便网站设计人员开发模板与管理。系统较为安全,以设计防注入,敏感字符屏蔽。新闻,产品,单页独立关键字设计,提高搜索引擎收录。 调试环境必须为IIS 后台账户密码:admin功能介绍:基本信息设置:网站名称,联系人等信息
-
配置Swagger UI: 修改Swagger UI的配置文件(通常是
index.html),将url参数指向你的API文档的URL。例如:script src="swagger-editor.js" type="text/javascript">script> window.onload = function() { const editor = SwaggerEditor({ url: "http://your-api-docs-url" // 替换为你的API文档URL }); };
三、访问和调试
-
访问Swagger UI: 在浏览器中访问
http://localhost:38081/swagger-ui.html(或你配置的URL)。 你将看到Swagger UI界面,列出可用的API接口。 -
测试API接口: 点击“TRY IT OUT”按钮测试API接口,验证其功能。
四、调试注意事项
-
检查容器状态: 使用
docker ps命令检查Swagger UI容器是否运行。 - 端口映射: 确保端口映射正确。
- 安全配置: 根据需要配置Swagger UI的安全设置(例如密码保护)。
五、使用IDE调试 (可选)
高级调试可以使用IDE(如IntelliJ IDEA或VS Code)进行远程调试。 需要在IDE中配置远程调试,连接到Swagger UI容器,设置断点,并启动调试会话。
通过以上步骤,你可以在Linux系统上成功部署和调试Swagger。 如有问题,请参考官方文档。









