本文介绍如何在Linux系统中利用Swagger提升API设计的效率和质量。我们将逐步讲解Swagger Editor、Swagger ui的安装和配置，以及在spring Boot项目中集成Swagger的方法，并演示如何使用Swagger注解定义API文档，最终在IntelliJ ideA中利用Swagger插件进行API设计和调试。
第一步：安装Swagger Editor和Swagger UI
首先，需要安装Node.JS和npm包管理器。使用以下命令：
sudo apt update sudo apt install -y nodejs npm
接下来，安装Swagger Editor：
wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.50.0.tar.gz tar -xvf swagger-editor-3.50.0.tar.gz cd swagger-editor-3.50.0 npm install npm run start
访问http://localhost:9000即可使用Swagger Editor。
同理，安装Swagger UI：
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.50.0.tar.gz tar -xvf swagger-ui-3.50.0.tar.gz cd swagger-ui-3.50.0 npm install npm run start
访问http://localhost:3000即可使用Swagger UI。
第二步：在spring boot项目中集成Swagger
在你的Spring Boot项目的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配置类（例如SwaggerConfig.Java）：
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; 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.basePackage("com.example.demo.controller")) //替换成你的controller包路径 .paths(PathSelectors.any()) .build(); } }
访问http://localhost:8080/swagger-ui.html即可查看Swagger UI生成的API文档。
第三步：使用Swagger注解定义API文档
在你的Controller类中使用Swagger注解来描述你的API：
import io.swagger.annotations.*; import org.springframework.web.bind.annotation.*; @RestController @Api(tags = "用户管理") public class UserController { @GetMapping("/users") @ApiOperation(value = "获取用户列表") public List<User> getUsers( @ApiParam(value = "分页信息", required = false) @RequestParam(value = "page", defaultValue = "1") int page, @ApiParam(value = "每页显示数量", required = false) @RequestParam(value = "size", defaultValue = "10") int size) { // ... } // ...其他API方法 }
第四步：在idea中使用Swagger插件进行API设计
安装Swagger插件（例如Swagger Plugin或OpenAPI 3 Editor），然后在IDEA中创建或编辑Swagger文档（YAML或json格式），直接在IDE中预览和调试API。
通过以上步骤，您可以充分利用Swagger来优化API设计，提高开发效率，并增强团队协作。 请根据实际项目情况调整代码中的包路径等信息。
