在现代化的软件开发中，API文档的实时同步对于提高开发效率和质量至关重要。Swagger是一个流行的API框架，能够实现API文档与代码的实时同步。以下是如何轻松实现Swagger API文档与代码实时同步的方法：

1. 添加Swagger依赖

要在Spring Boot项目中使用Swagger，首先需要在项目的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>

2. 创建Swagger配置类

创建一个配置类，使用@Configuration和@EnableSwagger2注解，以启用Swagger的自动配置。

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API 文档")
                .description("API 文档描述")
                .version("1.0.0")
                .build();
    }
}

在上述代码中，basePackage属性指定了Swagger要扫描的包路径。

3. 使用注解标记API

在Controller类和方法上使用Swagger提供的注解来标记API，这样Swagger就可以自动生成文档。

@RestController
@RequestMapping("/users")
@Api(tags = "用户管理")
public class UserController {
    @GetMapping("/{id}")
    @ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户信息")
    public User getUserById(@PathVariable Long id) {
        // 实现获取用户信息的逻辑
        return new User();
    }
}

4. 启动Swagger UI

当添加了依赖并配置了Swagger后，Swagger UI将会在Spring Boot应用的根路径下自动生成，通常为/swagger-ui.html。通过访问这个URL，你可以看到自动生成的API文档。

5. 实现实时同步

Swagger的一个关键特性是它能够与代码实时同步。当你修改了Controller中的代码，Swagger UI会自动重新加载并更新文档，无需手动刷新或重新生成。

6. 使用Swagger Codegen

Swagger Codegen是一个自动生成API客户端代码的工具，可以生成多种编程语言的代码框架。这样，前端开发者可以使用这些代码快速集成和调用API接口。

通过以上步骤，你可以轻松实现Swagger API文档与代码的实时同步，从而显著提升开发效率。Swagger的实时性和自动化特性使得开发人员能够更专注于业务逻辑的实现，而不用担心文档的维护问题。