课程信息:
- 课程名称:Swagger接口文档神器
- 章节名称:第二章 初识Swagger2
- 讲师姓名:晴天哥
课程内容:
1. Swagger有什么用:
· 支持页面展示接口定义,节省专门编写接口文档的时间
· 基于代码生成文档,规避接口文档老旧问题
· 支持接口调试,降低开发阶段调试成本
2. Swagger跨语言:
· 支持go和php语言的go-swagger和swagger-php
· 支持java语言的springfox
· 支持js和node语言的swagger-js和swagger-node
3. Swagger版本说明:
· Swagger历经1.x 2.x 3.x
· Swagger世面主流为2.x
· Swagger 3.0版本发布于2020.7
4. Swagger生逢其时:
· 软件开发进入微服务时代
· 构建微服务选择提供REST API接口调用
· 前后端分离开发模式
5. Swagger工具:
Swagger Editor - 开源编辑器
Swagger UI - 呈现可交互在线文档
Swagger Springfox - Swagger集成Spring生态
Swagger Editor:
Swagger Editor是一个开源的编辑器
基于YAML等语法定义API并自动生成文档
自动导出多种原因的服务端和客户端代码
Swagger UI:
一款Restful接口文档的在线生成工具
一款Restful接口的在线测试工具
便于开发人员轻松的进行各类交互
Swagger Springfox:
Springfox由swagger-springmvc发展而来
Springfox负责扫描代码提取信息生成API文档
Springfox通过Swagger UI呈现API文档
添加依赖:
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>3.0.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>3.0.0</version> </dependency>
学习心得:
本次课程我学到了Swagger更多的基础知识,学习了在springboot中引入Swagger的方式以及依赖。
课程截图: