使用Swagger2实现自动生成RESTful API文档

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

@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()
            .apiInfo(apiInfo());
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("Demo API 文档")
            .description("这是一个 Demo 的 API 文档")
            .version("1.0.0")
            .build();
    }
}

@Configuration
@EnableSwagger2
public class SwaggerConfig {
/*   在上面的代码中，我们定义了两个 Docket 对象，分别用于分组名为 v1 和 v2 的 API。在每个 Docket 对象中，我们都通过 `groupName()` 方法指定了分组名称，通过 `select()` 方法指定了 API 的扫描范围。最后，我们通过 `apiInfo()` 方法设置了 API 文档的基本信息。
### 2. API 安全认证
在实际开发中，我们通常会需要对一些敏感的 API 进行安全认证。Swagger2 也提供了相应的功能，可以帮助我们在 API 文档中添加安全认证信息。我们可以通过以下方式来配置 API 安全认证：
```java*/
@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()
            .apiInfo(apiInfo())
            .securitySchemes(Collections.singletonList(apiKey()))
            .securityContexts(Collections.singletonList(securityContext()));
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("Demo API 文档")
            .description("这是一个 Demo 的 API 文档")
            .version("1.0.0")
            .build();
    }
    private ApiKey apiKey() {
        return new ApiKey("token", "token", "header");
    }
    private SecurityContext securityContext() {
        return SecurityContext.builder()
            .securityReferences(Collections.singletonList(new SecurityReference("token", new AuthorizationScope[]{new AuthorizationScope("global", "accessEverything")})))
            .forPaths(PathSelectors.any())
            .build();
    }
}

@RestController
@RequestMapping("/users")
@Api(tags = "用户管理")
public class UserController {
    @Autowired
    private UserService userService;
    @GetMapping("/{id}")
    @ApiOperation(value = "获取用户", notes = "根据用户 ID 获取用户信息")
    public User getUser(@PathVariable("id") Long id) {
        return userService.getUserById(id);
    }
    @PostMapping
    @ApiOperation(value = "创建用户", notes = "创建新用户")
    public User createUser(@ApiParam(name = "用户对象", value = "需要创建的用户对象") @RequestBody User user) {
        return userService.createUser(user);
    }
}