Swagger概述

---

Swagger概述

1、前后端介绍

前后端分离：

• Vue + SpringBoot
• 后端：后端控制层，服务层，数据层【后端团队】
• 前端：前端控制层，视图层【前端团队】
  • 伪造后端数据，json，已经存在了，不需要后端，前端工程依旧能够跑起来
• 前后端如何交互 ==>API
• 前后端相对独立，松耦合
• 前后端甚至可以部署在不同的服务器上
• 前端测试后端接口：postman
• 后端提供接口，需要实时更新最新的消息及改动

2、简介

Swagger：

• 号称世界上最流行的Api框架
• RESTFul Api 文档在线自动生成工具 => Api文档于API定义同步更新
• 直接运行，可以在线测试API接口
• 支持多种语言：（Java、php…）
• Open API是一种规范以前叫做Swagger规范，是REST API的API描述格式
• Open API规范可以使用YAML或JSON格式进行编写，便于我们与机器进行阅读
• Swagger是一套Open API规范构建的开源工具
• Swagger UI：将Open API 规范呈现为交互式API文档，用可视化UI展示描述文件，浏览器中展示
• spring-fox是根据代码生成接口文档，修改代码文档也会同步更新
• 我们可以通过Swagger给一些比较难理解的属性或者接口，增加注释信息
• 接口文档实时更新
• 可以在线测试

3、官网

• Swagger官网：https://swagger.io/

4、如何使用

在项目使用Swagger需要springbox

• swagger2
• ui

5、注意事项

• 3.0.x访问地址：http://localhost:8080/swagger-ui/index.html
• 2.0.x访问地址：http://localhost:8080/swagger-ui.html
• 3.0.x需要在application.properties配置：spring.mvc.pathmatch.matching-strategy=ant_path_matcher
• 在正式发布的时候，关闭Swagger，出于安全考虑，而且节省运行的内存。