swagger学习

https://www.bilibili.com/video/av64841843?p=2  哔哩哔哩教学视频

 

springBoot集成swagger

需要的jar包 : Springfox Swagger2 和Springfox Swagger UI

 

1 新建项目，springBoot-web的项目

2 导入依赖

3 Hello工程

4 集成swagger

创建一个config文件夹

SwaggerConfig.java 

加入注解，@Configration 注入到springboot项目中

@EnableSwagger2  开启Swagger2

 

 4 测试（什么都没配置就是默认配置）

访问 http://localhost:8080/swagger-ui.html

 

 

二; 基本信息配置

阅读源码

首先创建一个Docket的bean实例

 

 2 创建一个apiInfo()类，实现apiInfo()方法,swagger默认的一些文档信息

 

 termsOfServiceUrl ：就是一个url链接，

 

 

三：扫描接口等

 

 

 

 basePackage是最常用的

 

 

 

 

 

 

 

测试环境下开启swagger,生产环境不开启swagger，如何做？

1判断环境

2注入enable

 

 

四：分组：

.groupName("default");

 

添加实体类，扫描到，只要接口的返回值是一个实体类，就能够扫描到该接口、

 

 

 添加注释

 

 

 

 

 

 生产环境一定要关闭swagger,防止接口的暴露，