前后端分离开发 Swagger 的使用(QuickStart)_若依中swagger怎么使用-优快云博客

本文链接：https://blog.youkuaiyun.com/weixin_51729463/article/details/120654419

Swagger通过Springfox库自动扫描代码，生成与代码同步的接口文档，解决了前后端沟通难题。开发者只需在Controller层定义接口，添加相关注解，通过配置SwaggerConfig启动Swagger。访问/swagger-ui.html即可查看和测试接口，极大地提高了开发效率和文档准确性。

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

Swagger 的使用(QuickStart)

1、背景

前后端分离开发时，沟通测试比较麻烦，需要不断地沟通。前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发。

相信无论是前端还是后端开发，都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。其实无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。但是这个接口文档对于程序员来说，就跟注释一样，经常会抱怨别人写的代码没有写注释，然而自己写起代码起来，最讨厌的，也是写注释。所以仅仅只通过强制来规范大家是不够的，随着时间推移，版本迭代，接口文档往往很容易就跟不上代码了。

2、swagger引入

通过在项目中引入Springfox，可以扫描相关的代码，生成该描述文件，进而生成与代码一致的接口文档和客户端代码。这种通过代码生成接口文档的形式，在后面需求持续迭代的项目中，显得尤为重要和高效。

3、swagger quick start

controller层提供接口

maven添加依赖

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

编写配置类SwaggerConfig

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2);
    }
}