作为一个RESTful风格的可视化框架,经常会和yapi作个比较,

相比于yapi其优势展现在:

  1. 自动实时更新接口信息
  2. 更强大的接口信息描述注解

劣势在于:

  1. 代码侵入性强
  2. UI不如Yapi好看(当然swagger的UI页面支持引入更换,且swagger3的UI比以往版本好看一些)
  3. Yapi还有权限管理、团队协作、自动化测试等功能

Swagger3目前已经将注解规范化,基于openApi3,且兼容以往版本的注解和配置

今天我们来看看简单的Swagger3版本整合到springboot项目中

pom依赖,这里springfox和springdoc都已经集成了swagger3
在这里插入图片描述

配置文件
在这里插入图片描述

controller层
在这里插入图片描述

最后在项目启动类上加上@EnableOpenApi注解,简单的swagger3就配置好了

来看下swagger提供的注解说明
在这里插入图片描述

项目启动后访问http://localhost:8080/swagger-ui/即可进入文档页面
在这里插入图片描述

Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐