SpringBoot生成RESTful API文档

由于我一开始学习的SpringBoot是3以上版本,所以我这里用到的也是支持和SpringBoot3能够整合的SpringDoc


这里先说一下,其实SpringDoc就是Swagger3版本,我一开始整合的2版本,比较麻烦况且最后SpringBoot程序都启动不了了,后面查资料才看到SpringDoc,好使的一批!!
官网地址:http://springdoc.org

一、依赖配置

在上篇文章中用到的项目模块基础上进行!

SpringBoot生成RESTful API文档_第1张图片

在pom.xml中添加该依赖,按照官网提供的最新版本

SpringBoot生成RESTful API文档_第2张图片

 接下来执行入口文件,就可以在浏览器通过swagger-ui.html访问该页面了

二、基础配置

SpringBoot生成RESTful API文档_第3张图片

  • 再去浏览器查看就能看到修改的内容了 

SpringBoot生成RESTful API文档_第4张图片

三、常用注解

@Tag 描述整个Controller
@Operation 描述具体接口信息
@Parameter

描述参数信息

@ApiResponse 接口相应描述信息
@Schema

描述对象以属性信息

四、练习

1、新建实体类

SpringBoot生成RESTful API文档_第5张图片

2、编写Controlle

SpringBoot生成RESTful API文档_第6张图片

3、查看

SpringBoot生成RESTful API文档_第7张图片

五、总结 

更多配置操作,可以去官网查看!有了SpringDoc就可以很好的自动生成和展示API文档了!

这样前后端分离就有已经有了雏形了,到时候再整合Mybatis就可以生成一个完整的API文档,就可以和前端分工明确了

你可能感兴趣的:(spring,boot,restful,spring)