【学习打卡】第15天 Swagger入门

第一模块

课程名称：Swagger接口文档神器

章节名称：1-1 ~ 2-2

讲师姓名：晴天哥

第二模块

内容概述：

1-1 ~ 2-2 小节主要讲解了Swagger是啥以及Swagger的周边生态。

第三模块

学习心得：

通过这3节的学习使我对Swagger有了一个初步的认识，知道了Swagger是为了解决啥问题而诞生的，他的诞生解决了一个怎样的行业痛点，以及对Swagger的周边生态有了比较清晰的认识。下面附上学习笔记：

1-1 Swagger 导学：

Swagger是个啥？

• restful接口文档的在线生成软件（restful接口就是符合restful规范的接口）

• restful接口的功能测试软件

• 前后端沟通的桥梁

Swagger解决的问题：

• 后端开发者wiki维护的问题

• 前后端开发者的沟通问题

• 提高测试开发者的效率

学习后可掌握的能力：

• swagger整合到springBoot中

• 使用swagger提供的注解，生成接口文档

• 通过swagger-UI进行接口测试【很有用！！！】

2-1 Swagger是啥：

前置知识：

Swagger是个啥：

Swagger工具介绍：

补充：

spring-fox-swagger：spring基于swagger规范可以将springMVC和springBoot项目中代码按照一定的规范自动生成JSON格式的描述文件，并最终通过Swagger-UI展示出来！！！

Swagger支持跨语言：

Swagger版本：

swagger-UI举例：

2-2 Swagger生态：

开源版的swagger有的功能：

• Swagger Codegen

• Swagger Editor

• Swagger  UI

Java领域用到的Swagger功能：

Swagger Editor：

开源的编辑器，基于YAML语法定义API并生成文档，自动导出多种语言大的服务端/客户端代码。

Editor语法举例：

Swagger UI：

restful接口文档的在线生成、测试工具，方便开发人员进行交流。

Swagger整合SpringBoot后的UI举例：

Swagger SpringFox：

由swaggerspringmvc发展而来，SpringFox负责扫描代码从而生成API文档，SpringFox通过Swagger-UI呈现API文档。

如何使用springFox：

第一步：引入依赖包：

版本为2.7.0，实际使用2.9.4是一样的。

第四模块

学习截图：