当前位置：首页 > 文章列表 > Golang > Go教程 > Debian实战：手把手教你Swagger+k8s集成超简单教程

Debian实战：手把手教你Swagger+k8s集成超简单教程

2025-06-19 23:12:17 0浏览收藏

想要在Debian系统上轻松集成Swagger与Kubernetes吗？本教程为你提供超详细的步骤指南！首先，我们将介绍如何在Debian系统上安装和配置Swagger UI，包括更新软件包、安装Node.js和npm，以及启动Swagger UI服务。接着，我们将指导你如何在Spring Boot项目中启用Swagger，包括添加Swagger依赖、配置Swagger参数，并创建一个简单的REST控制器进行测试。最后，我们将讲解如何通过Kubernetes部署Swagger组件，包括创建Swagger UI和Swagger Editor的Deployment，以及如何访问Swagger UI页面。通过本教程，你将能够快速掌握在Debian上集成Swagger与Kubernetes的关键技术，提升API文档管理和开发效率。

Debian下Swagger与Kubernetes如何集成

在Debian操作系统中将Swagger与Kubernetes进行整合，可按照如下流程操作：

Debian系统安装Swagger步骤

更新软件包列表并升级已安装的包：

<code>sudo apt update && sudo apt upgrade -y</code>

安装Node.js和npm（若尚未安装）：

<code>curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs</code>

全局安装Swagger UI：

<code>sudo npm install -g swagger-ui</code>

启动Swagger UI服务：

<code>swagger-ui --host localhost:3000</code>

随后，你可以在浏览器中打开 http://localhost:3000 来使用Swagger UI。

在Spring Boot项目中启用Swagger

生成Spring Boot工程：通过Spring Initializr创建一个新工程，并确保引入spring-boot-starter-web和spring-boot-starter-security模块。
添加Swagger依赖项：在pom.xml文件里加入以下springfox-boot-starter依赖：

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

配置Swagger参数：创建一个新的配置类用于设定Swagger相关选项。

<code>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.EnableSwagger2WebMvc;
<p>@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example"))
.paths(PathSelectors.any())
.build();
}
}</p></code>

编写测试用控制器：创建一个简单的REST控制器以供测试：

<code>import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;<p>@RestController
@RequestMapping("/api")
public class HelloController {
@GetMapping("/hello")
public String sayHello() {
return "Hello, Swagger!";
}
}</p></code>

运行Spring Boot应用：

<code>./mvnw spring-boot:run</code>

访问Swagger用户界面：打开浏览器，输入以下地址：

<code><a target='_blank'  href='https://www.17golang.com/gourl/?redirect=MDAwMDAwMDAwML57hpSHp6VpkrqbYLx2eayza4KafaOkbLS3zqSBrJvPsa5_0Ia6sWuR4Juaq6t9nq5roGCUgXpusdyfq5Zkhc3Ge5nam5a1b4eqcWSvdWmuyWt-noprj7Gxu7yogJ-flcaLqM6B3LGjgZiCnLB2l6uzgI1lfoCKsbK3yqGNrICas3icmJK3sWyR4H2qvIaGnrOmhWU' rel='nofollow'>http://localhost:8080/swagger-ui.html</a></code>

此时应能看到Swagger UI界面，并浏览到所定义的API文档。

Kubernetes部署Swagger组件

创建Swagger UI的Deployment：

<code>apiVersion: apps/v1
kind: Deployment
metadata:
name: swagger-ui
spec:
replicas: 1
selector:
matchLabels:
app: swagger-ui
template:
metadata:
labels:
app: swagger-ui
spec:
containers:<ul><li>name: swagger-ui
image: swaggerapi/swagger-ui:v4.6.0
ports:<ul><li>containerPort: 8080</li></ul></li></ul></code>

创建Swagger Editor的Deployment：

<code>apiVersion: apps/v1
kind: Deployment
metadata:
name: swagger-editor
spec:
replicas: 1
selector:
matchLabels:
app: swagger-editor
template:
metadata:
labels:
app: swagger-editor
spec:
containers:<li>name: swagger-editor
image: swaggerapi/swagger-editor:v4.6.0
ports:<ul><li>containerPort: 8080</li></ul></li></code>

访问Swagger UI页面：启动你的Spring Boot或Spring MVC应用后，在浏览器中输入如下URL来查看和调用API接口：

<code><a target='_blank'  href='https://www.17golang.com/gourl/?redirect=MDAwMDAwMDAwML57hpSHp6VpkrqbYLx2eayza4KafaOkbLS3zqSBrJvPsa5_0Ia6sWuR4Juaq6t9nq5roGCUgXpusdyfbZZljd6wi6SYm9yVrpqYgpyuiZyrtKOfp399eq7IlsqgjmSb0cedYpWZtp2pmtOCnMd1ZaPJgGmjebKGoq7ctKOOhoiZsXiD0Ie3tqSF0HVju599rbSNn2V_gI6ys5WzsoFkjJa9rovOh7Shdg' rel='nofollow'>http://your-k8s-node-ip:8080/swagger-ui/index.html</a></code>

通过上述步骤，即可实现在Debian平台上将Swagger整合进Spring Boot应用，并借助Kubernetes完成容器化部署。

以上就是《Debian实战：手把手教你Swagger+k8s集成超简单教程》的详细内容，更多关于的资料请关注golang学习网公众号！