在Ubuntu上进行Swagger调试,通常涉及以下几个步骤:
sudo apt update
sudo apt install -y nodejs npm
npm install -g swagger-editor
npm install -g swagger-ui
swagger-editor
默认情况下,它会在http://localhost:9000
运行。
swagger-ui
默认情况下,它会在http://localhost:8080
运行。
导入Swagger规范文件:
启动Swagger UI后,你可以通过浏览器访问http://localhost:8080
,然后点击“Explore”按钮,选择并导入你的Swagger规范文件(通常是swagger.json
或swagger.yaml
格式)。
调试API: Swagger UI提供了“Try it out”功能,允许你在线测试API接口。你可以在接口定义下方找到输入参数,填写相应的值,然后点击“Execute”按钮来测试API的响应。
为了更方便地部署和管理Swagger Editor和Swagger UI,你可以使用Docker容器:
安装Docker: 如果还没有安装Docker,可以参考Docker官方文档进行安装。
拉取Docker镜像:
docker pull swaggerapi/swagger-editor:v4.6.0
docker pull swaggerapi/swagger-ui:v4.15.5
docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0
docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5
这样,Swagger Editor将在http://localhost:38080
运行,而Swagger UI将在http://localhost:38081
运行。
通过以上步骤,你就可以在Ubuntu上成功安装和配置Swagger,进行API文档的生成、查看和调试。