如何用Ubuntu Swagger测试API

在Ubuntu系统上使用Swagger测试API，通常涉及以下几个步骤：

1. 安装Node.js和npm

首先，需要在Ubuntu系统上安装Node.js和npm。可以通过以下命令安装：

sudo apt update sudo apt install -y nodejs npm 

验证安装是否成功：

node -v npm -v 

2. 安装Swagger UI

有几种方法可以在Ubuntu上安装Swagger UI：

方法一：从GitHub克隆并运行

git clone https://github.com/swagger-api/swagger-ui.git cd swagger-ui npm install npm start 

然后，在浏览器中访问 http://localhost:3000/swagger-ui/index.html 即可看到Swagger UI界面。

方法二：使用npm全局安装http-server

sudo npm install -g http-server 

然后，解压Swagger UI的源码包（可以从Swagger官网下载），并将解压后的dist目录中的文件复制到Swagger UI源码目录中的public文件夹。接着，运行以下命令启动http-server：

http-server -p 8080 

在浏览器中访问 http://localhost:8080 即可看到Swagger UI界面。

3. 配置Swagger

如果你的后端服务是基于Spring Boot的，可以使用springfox-swagger2和springfox-swagger-ui来集成Swagger。首先，在pom.xml中添加依赖：

<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> 

然后，创建一个配置类来启用Swagger：

import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } } 

启动Spring Boot应用后，访问 http://localhost:8080/swagger-ui.html 即可看到Swagger UI界面，其中展示了项目中定义的所有API接口及其详细信息。

4. 测试API

在Swagger UI界面中，可以找到你定义的API接口，点击相应的接口，然后点击“Try it out”按钮即可测试API。你可以在“Params”部分输入参数，在“Body”部分输入请求体（如果是POST请求），然后点击“Execute”按钮执行请求并查看响应结果。

通过以上步骤，你就可以在Ubuntu系统上使用Swagger来测试API了。