Swagger学习笔记

1 介绍

key： Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并可进行接口调用和测试的服务.

1. 前后端分离：Vue + SpringBoot
   • 后端：后端控制层，服务层，数据访问层；
   • 前端：前端控制层，视图层；
2. 文档在线自动生成工具；可直接运行，在线测试API接口；支持多种语言；

---

2 使用

key： 没有SET方法，所以需要使用构造器Docket.

1. 配置：（需要SpringFox：需要swagger2和UI；SpringBoot集成了Swagger）

   • 新建SpringBoot项目（即Web项目）；

   • 导入相关依赖：
     

   • 配置Swagger-->使用注解@Configuration和@ EnableSwagger2；

   • 配置Swagger中Docket的bean实例（使用@Bean注解，看源码找具体可使用的方法）；

2. 配置用于扫描的接口与开关

   • 设置的接口会在类似这里的地方看到，使用Swagger会有默认的类似界面，可以更改外观：

     

   • 根据路径和属性使用Swagger配置类中的方法，实现对不同类型接口的扫描和展示；

   • 配置Swagger是否启动：使用enable(true/false);

3. API分组