本文介紹如何在Linux系統(tǒng)中利用Swagger提升API設(shè)計(jì)的效率和質(zhì)量。我們將逐步講解Swagger Editor、Swagger ui的安裝和配置，以及在spring Boot項(xiàng)目中集成Swagger的方法，并演示如何使用Swagger注解定義API文檔，最終在IntelliJ ideA中利用Swagger插件進(jìn)行API設(shè)計(jì)和調(diào)試。
第一步：安裝Swagger Editor和Swagger UI
首先，需要安裝Node.JS和npm包管理器。使用以下命令：
sudo apt update sudo apt install -y nodejs npm
接下來(lái)，安裝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
訪問(wèn)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
訪問(wèn)http://localhost:3000即可使用Swagger UI。
第二步：在spring boot項(xiàng)目中集成Swagger
在你的Spring Boot項(xiàng)目的pom.xml文件中添加以下依賴(lài)：
<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>
然后，創(chuàng)建一個(gè)Swagger配置類(lèi)（例如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(); } }
訪問(wèn)http://localhost:8080/swagger-ui.html即可查看Swagger UI生成的API文檔。
第三步：使用Swagger注解定義API文檔
在你的Controller類(lèi)中使用Swagger注解來(lái)描述你的API：
import io.swagger.annotations.*; import org.springframework.web.bind.annotation.*; @RestController @Api(tags = "用戶(hù)管理") public class UserController { @GetMapping("/users") @ApiOperation(value = "獲取用戶(hù)列表") public List<User> getUsers( @ApiParam(value = "分頁(yè)信息", required = false) @RequestParam(value = "page", defaultValue = "1") int page, @ApiParam(value = "每頁(yè)顯示數(shù)量", required = false) @RequestParam(value = "size", defaultValue = "10") int size) { // ... } // ...其他API方法 }
第四步：在idea中使用Swagger插件進(jìn)行API設(shè)計(jì)
安裝Swagger插件（例如Swagger Plugin或OpenAPI 3 Editor），然后在IDEA中創(chuàng)建或編輯Swagger文檔（YAML或json格式），直接在IDE中預(yù)覽和調(diào)試API。
通過(guò)以上步驟，您可以充分利用Swagger來(lái)優(yōu)化API設(shè)計(jì)，提高開(kāi)發(fā)效率，并增強(qiáng)團(tuán)隊(duì)協(xié)作。 請(qǐng)根據(jù)實(shí)際項(xiàng)目情況調(diào)整代碼中的包路徑等信息。
.png)
費(fèi)推廣.jpg)