首页 > 编程语言 > 详细

SpringBoot - Swagger (API文档实时更新工具)

时间:2020-12-08 09:39:49      阅读:34      评论:0      收藏:0      [点我收藏+]

1. 背景

1.1 前后端分离式时代

技术分享图片

 

前端项目会持有很多“假”数据,这些“假”数据应该通过后端从数据库查询而来。

然而在前后端分离时代,前端只需要知道数据的格式即可,后端只需要按需提供接口(接口产生出对应格式的数据即可)。

技术分享图片

 

 

1.2 产生的问题

技术分享图片

 

1.3 解决方案

早些年:用word

如今:用Swagger, Api文档与API定义同步更新

 

2. Swagger背景

技术分享图片

 

 

3. SpringBoot集成Swagger

技术分享图片

 

 

技术分享图片

 

 

技术分享图片

 

技术分享图片

 

 该html界面位置在:

技术分享图片

 

 

4. Swagger UI自定义配置

4.1 自定义左上角“Swagger信息”模块

技术分享图片

 

技术分享图片

 

 

4.2 自定义右上角“分组”模块

技术分享图片

 

向ioc容器中,注册多个Docket bean即可:

技术分享图片

 

 

4.3 底部“实体类信息”模块

4.3.1 如何在该模块显示一个实体类Model?

技术分享图片

 

 

4.3.2 如何给实体类加注释?

技术分享图片

 

 

技术分享图片

 

4.3.3 如何给Controller加注释?

技术分享图片

 

 

技术分享图片

 

 

 

 

 

5. Swagger配置扫描接口

技术分享图片

 

 

6. 模拟前端测试接口(重要)

 

技术分享图片

 

 

技术分享图片

 

 

技术分享图片

 

 

 

 

面试题:如何让开发环境使用swagger,而生产环境禁用?

前提:项目中需要有多环境的配置文件

技术分享图片

 

 

通过enable()来开启/关闭:

技术分享图片

 

SpringBoot - Swagger (API文档实时更新工具)

原文:https://www.cnblogs.com/frankcui/p/14100584.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!