温馨提示×

Swagger在Linux上如何与Spring Boot集成

小樊
36
2025-11-30 05:39:33
栏目: 智能运维

要在Linux上将Swagger与Spring Boot集成,请按照以下步骤操作:

  1. 首先,确保你已经在你的Linux系统上安装了Java和Maven。如果没有,请访问官方网站下载并安装Java,然后访问Maven官方网站下载并安装Maven。

  2. 使用命令行或文本编辑器,创建一个新的Spring Boot项目,或者克隆一个现有的Spring Boot项目。如果你需要创建一个新项目,可以使用Spring Initializr生成一个基本的项目结构。

  3. 在项目的pom.xml文件中,添加以下依赖项以集成Swagger:

<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>
  1. 创建一个新的Java类,例如SwaggerConfig.java,并添加以下代码以配置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.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

请将com.example.demo.controller替换为你的控制器类所在的包名。

  1. 保存更改并重新构建项目。在项目根目录下运行以下命令:
mvn clean install
  1. 运行Spring Boot应用程序。在项目根目录下运行以下命令:
java -jar target/your-app-name.jar

请将your-app-name.jar替换为你的应用程序的JAR文件名。

  1. 打开浏览器并访问http://localhost:8080/swagger-ui.html。你应该看到Swagger UI界面,其中列出了你的API端点。

现在你已经在Linux上成功地将Swagger与Spring Boot集成。你可以使用Swagger UI界面来测试和探索你的API。

0