掌握：
-
Swagger的作用和概念
-
前后端分离概念
-
在Springboot中集成Swagger
前后端分离
当前：vue+springboot
后端时代：前端只管理静态页面。写好后交给（html页面）交给后端处理。当时用到的模板引擎JSP，需要放进服务器跑，后端是主力。
前后端分离时代：
- 后端：后端服务层，服务层，数据访问层 【后端团队】
- 前端：前端控制层，视图层 【前端团队】
- 伪造后端数据，json数据。不需要后端团队程序也能跑起来
- 前后端交互 ===> API
- 前后端相对独立，松耦合
- 前后端可以部署在不同服务器
产生问题：
- 前后端集成联调，前端人员和后端人员无法做到“即使协商，尽早解决”，最终导致问题集中爆发。
解决办法：
- 首先制定schema(计划/提纲/纲要)。实时更新最新API，降低集成风险
- 早些年，制定work计划文档。
- 前后端分离：
- 前端测试后端接口：postman
- 后端提供接口，需要实时更新最新消息及改动。
Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。
Swagger 的优势
- 支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。
- 提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。
查看官网
项目中使用Swagger需要springboot
- swagger2
- ui
测试地址/swagger-ui.html，出现swagger接口文档页面
使用提供的构造方法接管默认的方法
Swagger的bean实例Docket
Docket.select()
源码中有具体详细的实现过程
Q:在生产环境中使用swagger，在发布的时候不使用。
A:获取当前项目生产环境，判断是否为设定的的环境，否则返回false
协作开发使用，设置不同分组扫描自己的接口，用于说明
配置多个分组：设置多个Docket即可
给属性或接口写注释信息：
我们可以通过swagger给一些比较难理解的属性或接口写注释信息，并且接口文档实时更新，支持在线测试
注意：
在正式发布的时候关闭Swagger
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。
如需转载请保留出处：https://bianchenghao.cn/bian-cheng-ri-ji/14038.html