在linux系統(tǒng)中,借助Swagger集成spring Boot項(xiàng)目,可以高效便捷地生成restful API文檔。以下步驟將指導(dǎo)您完成集成過(guò)程:
第一步:添加依賴(lài)
在您的spring boot項(xiàng)目的pom.xml文件中,添加以下maven依賴(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>
第二步:Swagger配置
創(chuàng)建一個(gè)名為SwaggerConfig.Java的Java配置類(lèi),并添加如下代碼:
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")) // 請(qǐng)?zhí)鎿Q為您的控制器包名 .paths(PathSelectors.any()) .build(); } }
請(qǐng)務(wù)必將com.example.demo.controller替換為您實(shí)際的控制器包名。
第三步:訪(fǎng)問(wèn)Swagger UI
啟動(dòng)Spring Boot應(yīng)用后,在瀏覽器中訪(fǎng)問(wèn)以下URL:
您將看到Swagger UI界面,其中包含了所有已注冊(cè)的API接口信息。您可以直接在此界面測(cè)試您的API。
重要提示: 如果在Linux環(huán)境下無(wú)法訪(fǎng)問(wèn)http://localhost:8080/swagger-ui.html,請(qǐng)檢查您的防火墻設(shè)置,確保8080端口已開(kāi)放。 此外,請(qǐng)確認(rèn)Spring Boot應(yīng)用已成功啟動(dòng)并在監(jiān)聽(tīng)8080端口。
? 版權(quán)聲明
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載。
THE END