阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api

已经开发完了两个接口,一个是注册,一个是判断用户名是否存在。

阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第1张图片

引入swagger2

阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第2张图片

引入这一段相应的依赖
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第3张图片
父工程内添加引用。核心内容都是在springfox-swagger2
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第4张图片前两个是官方提供的,从groupId就可以看出来。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第5张图片

这一个是自行添加的。由其他的开发人员所发布的UI阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第6张图片

编写配置

在Api的微服务里面,创建config的包。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第7张图片
创建swagger2
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第8张图片
让Springboot容器扫描到。加上@Configuration的注解。加上注解后就会被扫描到。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第9张图片
第二步,要开启swagger2的配置。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第10张图片
配置swagger2的核心配置,被称为docket
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第11张图片

阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第12张图片

进入到documentionType里面,发现对应的三种版本,我们使用的是2.0的 对应的是swagger_2
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第13张图片


阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第14张图片
响应式的编程风格,在后面直接,点 apiInfo
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第15张图片
点进来查看ApiInfo
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第16张图片
进入ApiInfo
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第17张图片
ApiInfo里面包含了很多的属性。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第18张图片

我们重新的去创建一个新的方法。返回ApiInfo类型的
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第19张图片

apiInfo在主方法内调用。

阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第20张图片

配置扫描包的地址

配置扫描包所在的地址,也就是我们现有的所有的controller所在的地址。
,目前我们所有的controller都在com.imooc.controller包下。那么所需要去生成的文档,要根据哪些controller来。他们的源头又是在哪个包呢。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第21张图片
使用select选择器,里面有个apis里面的参数是RequestHandler,RequestHandler就是一个选择器。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第22张图片

基础的包名
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第23张图片
Path指定扫描包,扫描哪些,这里any是所有的。最后调用build方法。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第24张图片
这样我们的配置就都配置好了。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第25张图片
最后再加上@Bean的注解。让它编程一个Spring的Bean
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第26张图片

swagger2的访问路径、

阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第27张图片

执行 maven install

阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第28张图片

运行测试

启动api服务。输入地址测试。

阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第29张图片

就是代码的这一部分信息
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第30张图片

阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第31张图片



测试用户名的调用
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第32张图片

 

阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第33张图片

换肤

使用的就是我们之前引入的这个依赖。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第34张图片
访问路径比较简单
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第35张图片
doc.html。分成了左右,左边是导航,右边是信息。
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第36张图片
阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第37张图片

测试用户名是否存在的接口。

阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api_第38张图片

结束


 

你可能感兴趣的:(阶段一-01.万丈高楼,地基首要-第3章 用户登录注册模块开发-3-6 整合Swagger2文档api)