信息发布→ 登录 注册 退出

Linux Swagger与Spring Boot如何集成

发布时间:2025-04-10

点击量:

Spring Boot项目轻松集成Swagger:详细步骤指南

本文将指导您如何在spring boot项目中快速集成swagger,方便api文档的生成和测试。 以下步骤将帮助您轻松完成集成,并开始使用swagger ui浏览您的api。

第一步:添加依赖

在您的pom.xml文件中添加以下Swagger依赖:


    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2

请根据您的实际需求选择合适的Swagger版本。

第二步:Swagger配置

创建一个名为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();
    }
}

请务必将com.example.demo.controller替换为您实际的Controller包名。

第三步:访问Swagger UI

启动您的Spring Boot应用程序后,在浏览器中访问以下URL:

http://localhost:8080/swagger-ui.html

(假设您的应用程序运行在8080端口)。您应该能够看到Swagger UI界面,其中列出了您的API文档,方便您进行测试和浏览。

现在,您已成功将Swagger集成到您的Spring Boot项目中。 您可以使用Swagger UI直观地查看和测试您的API。

标签:# 应用程序  # 进行测试  # 第三步  # 创建一个  # 第二步  # 您可以  # 为您  # 出了  # 文档  # linux  # 您的  # ui  # xml  # spring boot  # spring  # Java  # 浏览器  
在线客服
服务热线

服务热线

4008888355

微信咨询
二维码
返回顶部
×二维码

截屏,微信识别二维码

打开微信

微信号已复制,请打开微信添加咨询详情!