2026年swagger注解大全（swagger的注解）

编程日记 • 2026-01-18 07:21 • 阅读 0

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务(https://swagger.io/)。

它的主要作用是：

使得前后端分离开发更加方便，有利于团队协作
接口的文档在线自动生成，降低后端开发人员编写接口文档的负担
功能测试Spring 已经将 Swagger 纳入自身的标准，建立了 Spring-swagger 项目，现在叫 Springfox。通过在项目中引入 Springfox ，即可非常简单快捷的使用 Swagger。

knife4j 是为 Java MVC 框架集成 Swagger 生成 Api 文档的增强解决方案,前身是 swagger-bootstrap-ui,取名 kni4j 是希望它能像一把匕首一样小巧,轻量,并且功能强悍!

目前，一般都使用 knife4j 框架。

1、导入 knife4j 的 maven 坐标

在 pom.xml 中添加依赖

2、在配置类中加入 knife4j 相关配置

WebMvcConfiguration.java

3、设置静态资源映射，否则接口文档页面无法访问

WebMvcConfiguration.java

4、访问测试

接口文档访问路径为 http://ip:port/doc.html —> http://localhost:8080/doc.html

接口测试:测试登录功能

思考：通过 Swagger 就可以生成接口文档，那么我们就不需要 Yapi 了？

1、Yapi 是设计阶段使用的工具，管理和维护接口

2、Swagger 在开发阶段使用的框架，帮助后端开发人员做后端的接口测试

通过注解可以控制生成的接口文档，使接口文档拥有更好的可读性，常用注解如下：

接下来，使用上述注解，生成可读性更好的接口文档

在 sky-pojo 模块中

EmployeeLoginDTO.java

EmployeeLoginVo.java

在 sky-server 模块中

EmployeeController.java

启动服务：访问http://localhost:8080/doc.html

今天的文章 2026年swagger注解大全（swagger的注解）分享到此就结束了，感谢您的阅读。