Swagger简介

前后端分离

Vue + SpringBoot

后端时代：前端只用管理静态页面；html ==> 后端 。 模板引擎 JSP ==> 后端是主力

前后端分离时代：

• 后端：后端控制层，服务层，数据访问层 【后端团队】
• 前端：前端控制层，视图层 【前端团队】
  • 伪造后端数据，json。已经不存在了，不需要后盾，前端工程依旧能跑起来
• 前后端如何交互？ ===> API
• 前后端相对独立，松耦合；
• 前后端设置可以部署在不同的服务器上；

产生一个问题：

• 前后端集成联调，前端人员和后端人员无法做到，及时协商，尽早解决。最终导致问题集中爆发；

解决方案：

• 首先制定schema[计划的提纲]，实时更新最新API，降低集成的风险；

• 早些年：制定word计划文档；

• 前后端分离：

  • 前端测试后端接口：postman
  • 后端提供接口，需要实时更新最新的消息及改动

Swagger

• 号称是世界上最流行的API框架；
• RestFul Api 文档再现自动生成工具=> API文档与API定义同步更新
• 直接运行，可以在线测试API接口
• 支持多种语言：（Java，PHP）

官网：https://swagger.io/

在项目中使用Swagger需要springbox；

• Swagger2
• UI

SpringBoot集成Swagger

1. 新建一个SpringBoot = web项目
2. 导入相关依赖

swagger 2

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

  

 

  
1
  
2
  
3
  
4
  
5
  
6
 

swagger ui

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

  

 

  
1
  
2
  
3
  
4
  
5
  
6
 

3. 编写一个hello工程
4. 配置Swagger ==> Config

@Configuration
@EnableSwagger2 //开启swagger 2
public class SwaggerConfig {
    
}

  

 

  
1
  
2
  
3
  
4
  
5
 

5. 测试运行

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-fGda8IvO-1632796863693)(C:\Users\ZWB\AppData\Roaming\Typora\typora-user-images\image-20210910101755535.png)]

文章来源: blog.csdn.net，作者：翟文彪，版权归原作者所有，如需转载，请联系作者。

原文链接：blog.csdn.net/zwb568/article/details/120524382