Swagger3/2+Spring boot 使用小结

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。在Spring Boot项目中使用Swagger，可以帮助开发者简化REST API的文档、测试和共享。

以下是Swagger 3/2与Spring Boot结合使用的一些关键点和示例：

引入Swagger依赖：




<!-- Swagger 3 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

配置Swagger：




@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

在Controller中使用Swagger注解：




@Api(value = "用户管理", tags = "用户管理接口")
@RestController
@RequestMapping("/users")
public class UserController {
 
    @ApiOperation(value = "获取用户列表", notes = "获取用户列表")
    @GetMapping("/")
    public ResponseEntity<List<User>> getUserList() {
        // ...
    }
 
    @ApiOperation(value = "创建用户", notes = "创建用户")
    @PostMapping("/")
    public ResponseEntity<User> createUser(@RequestBody User user) {
        // ...
    }
 
    // ...
}

访问Swagger UI：

启动Spring Boot应用后，可以通过访问 http://<host>:<port>/swagger-ui/index.html 来查看Swagger生成的API文档。

自定义Swagger配置：

添加API分组
设置API文档的全局参数、响应消息等
应用安全设置，如Basic Auth、Bearer Token等

确保生产环境安全：

禁用Swagger或限制访问
使用Swagger的权限控制功能

更新Swagger依赖：




<!-- Swagger 3 依赖更新 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

升级Spring Boot和Swagger版本时，确保兼容性。

总结：

在Spring Boot项目中使用Swagger，首先需要引入Swagger依赖，然后配置Swagger。在Controller类和方法上使用Swagger注解描述API。启动应用后可以通过Swagger UI访问API文档。在生产环境中，确保Swagger的使用是安全的，不暴露敏感信息。定期更新Swagger依赖，保证与Spring Boot的兼容性。

Swagger3/2+Spring boot 使用小结

评论已关闭

推荐阅读