当前位置：首页 > article >正文

springboot在线文档的集成方式

article 2025/3/11 6:21:05

为了使用Swagger 3，您需要进行以下步骤来将其集成到您的项目中：

添加Swagger依赖项：在您的项目的构建文件中，例如pom.xml（如果您的项目是基于Maven），添加Swagger库的依赖项。您可以在Maven中添加以下内容：

<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'

配置Swagger：在您的Spring Boot主配置类上添加@EnableSwagger2 或 @EnableSwagger2WebMvc 注解。这将启用Swagger在您的应用程序中生成API文档。
配置Swagger文档：根据您的应用程序的需求，您可以配置Swagger生成的API文档。您可以为每个控制器配置文档注释，路径选择器和参数注释等。

以下是一个示例控制器的Swagger文档配置：

@RestController
@Api(tags = "User API")
public class UserController {

    @ApiOperation("Get user details")
    @GetMapping("/users/{id}")
    public User getUser(@PathVariable Long id) {
        // ...
    }
}

在上面的示例中，@Api 注解用于为控制器组添加标签，@ApiOperation 注解用于为接口添加操作描述。

启动应用程序：现在，您可以启动您的Spring Boot应用程序，并访问Swagger UI界面以查看生成的API文档。默认情况下，Swagger UI可以通过http://localhost:8080/swagger-ui/index.html访问。

这是一个基本的Swagger 3集成过程的概述。您可以根据您的需求和应用程序的特定要求进行更多的配置和自定义。

要在Spring Boot中集成Knife4j，可以按照以下步骤进行操作：

首先，在Spring Boot项目中添加相关依赖。在pom.xml文件中，添加如下依赖：

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.2</version>
    <scope>compile</scope>
</dependency>

创建一个Swagger2配置类，例如SwaggerConfig.java，并添加@Configuration注解。在该配置类中，可以配置Swagger的一些基本信息，如标题、描述、版本等。

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API文档")
                .description("API文档")
                .version("1.0")
                .build();
    }
}

在应用启动类中添加@EnableKnife4j注解，启用Knife4j自动配置。

@SpringBootApplication
@EnableKnife4j
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}