为了账号安全,请及时绑定邮箱和手机立即绑定
首页 手记 【金秋打卡】第20天 Swagger接口文档神器 03

【金秋打卡】第20天 Swagger接口文档神器 03

2022.11.14 09:40 68浏览

课程信息:

- 课程名称:Swagger接口文档神器

- 章节名称:第三章 Swagger实战 3-1 Swagger注解

- 讲师姓名:晴天哥


课程内容:

 1. Swagger整体注解:

  • Swagger2请求类注解

  • Swagger2请求方法注解

  • Swagger对象类注解

2. Swagger2请求类注解

  • @API表示Swagger识别的类

  • @API放在@Controller注解并列的请求类

  • 核心参数包括value、tags、descripion

3. Swagger2请求方法注解

  • @ApiOperation标识Swagger识别的方法

  • @ApiImplicitParam表示方法的参数说明

  • @ApiResponse标识方法返回值的说明

4. Swagger2对象类的注解

  • @ApiModel标识Swagger识别的JavaBeen

  • @ApiModel放在JavaBeen的类定义上

  • @ApiModelProperty表示JavaBeen的属性

5. Controller封装

  • Controller的方法必须明确指定请求类型

  • 确少请求类型的情况下列出所有请求类型

6. 生产环境控制

  • Swagger在生产环境不能对外暴露

  • 通过@Profile({"dev", "prod", "test"})指定环境

https://img1.sycdn.imooc.com/636cc9170001a0d611310644.jpg

通过上面方法在IDEA中来指定环境

7. 默认访问地址

  • 默认的访问地址需要携带默认访问路径

  • 通过server.contestPath指定默认访问路径

https://img4.sycdn.imooc.com/636ccafb000195e508920327.jpg

8. Swagger权限控制

  • Swagger2登录安全认证

https://img4.sycdn.imooc.com/636ccb7f0001ebd711520666.jpg

  • Swagger2 BasicAuth身份认证

https://img1.sycdn.imooc.com/636ccbb30001917209450650.jpg

  • Swagger2 ApiKey身份认证

https://img3.sycdn.imooc.com/636ccbd20001faec11120653.jpg

9. Swagger多环境控制

  • 代码部署环境区分开发测试线上

  • 基于安全靠量线上禁用Swagger

  • 通过多种配置方式支持多环境配置

https://img2.sycdn.imooc.com/636ccda60001fd1111850661.jpg

学习心得:

本次学习我了解了Springboot整合Swagger的整体方法,收获非常大,Swagger是一种非常好的工具。

课程截图:

https://img3.sycdn.imooc.com/636cbe930001a25f13400720.jpg


https://img4.sycdn.imooc.com/636cc0e70001890b11710680.jpg

点击查看更多内容
0人点赞

若觉得本文不错,就分享一下吧!

评论

作者其他优质文章

正在加载中
手记
粉丝
0
获赞与收藏
2

关注TA,一起探索更多经验知识

同主题相似文章浏览排行榜

风间影月说签约讲师

51篇手记,涉及Java、MySQL、Redis、Spring等方向

进入讨论

Tony Bai 说签约讲师

152篇手记,涉及Go、C、Java、Python等方向

进入讨论
感谢您的支持,我会继续努力的~
扫码打赏,你说多少就多少
赞赏金额会直接到老师账户
支付方式
打开微信扫一扫,即可进行扫码打赏哦
意见反馈 帮助中心 APP下载
官方微信

举报

0/150
提交
取消