在Ubuntu上使用Swagger进行API文档化和测试的步骤如下:
首先,确保你的系统上已经安装了Node.js和npm。可以通过以下命令安装:
sudo apt update
sudo apt install nodejs npm
npm install -g swagger-editor
npm install -g swagger-ui-express
sudo apt update
sudo apt install docker.io
docker pull swaggerapi/swagger-ui-express
docker run -p 8080:8080 swaggerapi/swagger-ui-express
http://localhost:8080
,你应该能看到Swagger UI界面。http://localhost:8080
,使用你保存的Swagger YAML文件进行API文档的编辑和查看。http://localhost:3000
,在页面中输入你的Swagger YAML文件的URL,然后点击“Explore”按钮查看和测试API。swagger.yaml
或 swagger.json
文件。创建Spring Boot项目:使用Spring Initializr创建一个新的Spring Boot项目,并添加Spring Web和Springfox Swagger2依赖。
添加Swagger依赖:在 pom.xml
文件中添加Springfox Swagger2和Swagger UI的依赖。
配置Swagger:创建一个配置类来配置Swagger,指定API的详细信息。
创建一个简单的Controller:创建一个简单的Controller来测试Swagger。
运行Spring Boot应用:在终端中运行 ./mvnw spring-boot:run
启动Spring Boot应用。
访问Swagger UI:打开浏览器并访问 http://localhost:8080/swagger-ui.html
查看Swagger UI界面。
以上步骤应该可以帮助你在Ubuntu上成功安装和配置Swagger,并进行接口测试。如果在安装过程中遇到问题,可以参考相关的官方文档或社区论坛寻求帮助。