前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >SpringBoot生成RESTful API文档

SpringBoot生成RESTful API文档

作者头像
chao超的搬运文章
发布2023-10-15 19:23:39
2270
发布2023-10-15 19:23:39
举报
文章被收录于专栏:java,hbasejava,hbase

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

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

一、依赖配置

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

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

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

二、基础配置

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

三、常用注解

@Tag

描述整个Controller

@Operation

描述具体接口信息

@Parameter

描述参数信息

@ApiResponse

接口相应描述信息

@Schema

描述对象以属性信息

四、练习

1、新建实体类

2、编写Controlle

3、查看

五、总结 

更多配置操作,可以去官网查看!有了SpringDoc就可以很好的自动生成和展示API文档了! 这样前后端分离就有已经有了雏形了,到时候再整合Mybatis就可以生成一个完整的API文档,就可以和前端分工明确了

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2023-06-07,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 一、依赖配置
  • 二、基础配置
  • 三、常用注解
  • 四、练习
  • 五、总结 
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档