Spring Boot 实战（12）springboot 整合 swagger2

最新推荐文章于 2024-03-12 15:59:14 发布

扬帆向海

最新推荐文章于 2024-03-12 15:59:14 发布

阅读量2.9w

点赞数 24

分类专栏： Spring Boot

本文链接：https://blog.csdn.net/weixin_43570367/article/details/103788518

版权

Spring Boot 专栏收录该内容

16 篇文章 63 订阅

订阅专栏

写在前面：我是「扬帆向海」，这个昵称来源于我的名字以及女朋友的名字。我热爱技术、热爱开源、热爱编程。技术是开源的、知识是共享的。

这博客是对自己学习的一点点总结及记录，如果您对 Java、算法感兴趣，可以关注我的动态，我们一起学习。

用知识改变命运，让我们的家人过上更好的生活。

相关文章：

Springboot 系列文章

文章目录

一、Swagger2 介绍

1. Swagger2 出现的背景

现如今，前后端分离已经逐渐成为互联网项目一种标准的开发方式，前端与后端交给不同的人员开发，但是项目开发中的沟通成本也随之升高，这部分沟通成本主要在于前端开发人员与后端开发人员对WebAPI接口的沟通，Swagger2 就可以很好地解决，它可以动态生成Api接口文档，降低沟通成本，促进项目高效开发。

2. 什么是 Swagger2

Swagger2 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

3. Swagger 的特点

及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
可测性 (直接在接口文档上进行测试，以方便理解业务)

二、springboot 整合 swagger2

1、在pom中添加依赖

<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>

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

2、创建Swagger2配置文件

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket webApiConfig() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .build();
    }

    private ApiInfo webApiInfo() {
        return new ApiInfoBuilder()
                .title("网站-扬帆向海的博客文档")
                .description("本文档描述了博客中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("扬帆向海", "http://zhangxy.com", "zhangxy@126.com"))
                .build();
    }

}