linux

Linux下Swagger与Spring Boot如何集成

小樊
31
2025-03-12 00:43:41
栏目: 智能运维

在Linux环境下,将Swagger与Spring Boot集成可以帮助你更好地为你的RESTful API创建文档。以下是集成Swagger与Spring Boot的步骤:

  1. 添加依赖

在你的Spring Boot项目的pom.xml文件中,添加以下依赖:

<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. 配置Swagger

创建一个新的Java类,例如SwaggerConfig.java,并添加以下代码:

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. 访问Swagger UI

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

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

你应该能看到Swagger UI界面,其中列出了你的所有API接口。你可以使用这个界面来测试你的API接口。

注意:如果你在Linux环境下遇到无法访问http://localhost:8080/swagger-ui.html的问题,请检查防火墙设置,确保端口8080是开放的。

0
看了该问题的人还看了