Swagger在Debian上如何配置使用

Swagger在Debian上如何配置使用

debian系統上配置Swagger需要遵循一系列步驟,包括軟件包的安裝、API文檔生成工具的配置以及Swagger ui的設置。以下是完整的操作指南:

1. 更新系統并安裝所需軟件包

首先,確保Debian系統的軟件包列表是最新的:

sudo apt-get update sudo apt-get upgrade

然后,安裝Swagger相關的軟件包,特別是spring Boot開發工具及其依賴項:

sudo apt-get install spring-boot-devtools

2. 設置spring boot項目環境

在你的Spring Boot項目里,加入Swagger所需的依賴項。如果使用maven,需在 pom.xml 文件中添加如下依賴:

<dependency><groupid>io.springfox</groupid><artifactid>springfox-boot-starter</artifactid><version>3.0.0</version></dependency>

對于gradle用戶,則應在 build.gradle 文件中插入以下依賴:

implementation 'io.springfox:springfox-boot-starter:3.0.0'

3. 創建Swagger配置類

于項目內建立一個配置類來生成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.basePackage("com.example.demo"))                 .paths(PathSelectors.any())                 .build();     } }

記得將 com.example.demo 替換為實際的控制器所在包名。

4. 瀏覽Swagger UI

啟動Spring Boot應用后,可通過以下鏈接訪問Swagger UI界面:

https://www.php.cn/link/3f2624ba9ffc5ebd40c98284e1379e99

5. docker配置(可選)

若打算在Docker容器中運行Spring Boot應用,可參考以下步驟:

編寫Dockerfile

在項目根目錄創建 Dockerfile 文件:

FROM openjdk:11-jre-slim COPY target/demo-0.0.1-SNAPSHOT.jar app.jar ENTRYPOINT ["java", "-jar", "app.jar"]

打包并構建鏡像

在項目根目錄執行以下命令以構建Docker鏡像:

docker build -t demo .

啟動Docker容器

構建成功后,利用以下命令運行Docker容器:

docker run -p 8080:8080 demo

此時,即可通過 https://www.php.cn/link/3f2624ba9ffc5ebd40c98284e1379e99瀏覽器中查看Swagger UI。

? 版權聲明
THE END
喜歡就支持一下吧
點贊6 分享