Spring Boot中使用Swagger2快速构建RESTful API文档

最新推荐文章于 2024-11-16 19:31:11 发布

原创最新推荐文章于 2024-11-16 19:31:11 发布 · 217 阅读

1 ·

CC 4.0 BY-SA版权

swagger 专栏收录该内容

1 篇文章

订阅专栏

本文详细介绍如何在SpringBoot项目中整合Swagger2，以构建RESTfulAPI文档。通过配置依赖和Swagger2配置类，可以自动生成API文档并提供页面测试功能。

Swagger2，它可以轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示：

在pom.xml中加入Swagger2的依赖


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

创建Swagger2配置类

在Application.java同级创建Swagger2的配置类Swagger2。注意basepackage中的包名要改为你自己的包名，才可以扫描的到


@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.lyb.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("更多Spring Boot相关文章请关注：linyongbin")
                .contact("linyongbin")
                .version("1.0")
                .build();
    }

}

我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明。