SpringBoot整合Swagger2

最新推荐文章于 2024-01-12 16:22:16 发布

原创最新推荐文章于 2024-01-12 16:22:16 发布 · 221 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #restful #spring

Swagger2是一个用于生成、描述和可视化RESTfulWeb服务接口的框架。它帮助企业统一接口文档标准，尤其在前后端分离的项目中，提供API文档的重要工具。通过添加依赖、配置类和使用特定注解，开发者可以轻松创建和管理API接口文档。Swagger2还支持在线文档预览和模拟HTTP请求功能。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.什么是Swagger2

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档 . 接口: controller相应的路径方法

2.为什么使用Swagger2

为了解决企业中接口（api）中定义统一标准规范的文档生成工具。很多采用前后端分离的模式，前端只负责调用接口，进行渲染，前端和后端的唯一联系，变成了API接口。因此，API文档变得越来越重要。swagger是一个方便我们更好的编写API文档的框架，而且swagger可以模拟http请求调用。

3.如何使用接口文档Swagger2

3.1导入相关依赖

<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.9.1.RELEASE</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.7.8</version>
</dependency>

3.2创建一个配置类 ------swagger2

@Configuration
@EnableSwagger2 //开启swagger注解驱动
public class SwaggerConfig {
    @Bean //把方法返回的数据对象 交于spring容器管理
    public Docket docket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2).groupName("QY163")
                .apiInfo(getInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.lzx.controller")) //只为com.ykq.controller包下的类生成接口文档
                .build();
        return docket;
    }

    private ApiInfo getInfo(){
        Contact DEFAULT_CONTACT = new Contact("林深见鹿", "http://www.baidu.com", "120@qq.com");
        ApiInfo apiInfo=new ApiInfo("心里测试系统API", "心里测试系统API", "1.1.0", "http://www.jd.com",
                DEFAULT_CONTACT, "志远科技", "http://www.aaa.com", new ArrayList<VendorExtension>());
        return apiInfo;
    }
}

3.3访问swagger在线文档

Swagger-Bootstrap-UIhttp://localhost:8080/doc.html访问路径

3.4 swagger中常用的注解

使用swagger注解对接口参数加以说明。

@Api（tags=""）====使用在controller类上

@ApiOperation(value="")====接口方法上接口方法加以说明

@ApiParam(value = "",name = "",required = true)

@ApiModel====实体类

@ApiModelProperty===>实体类的属性说明