Hello! 欢迎来到小浪云!


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。

相关阅读