访问swagger页面,但是无接口信息?
在前后端分离开发的今天,接口文档显得尤为重要,其重要性有以下几点:
1、约定接口信息,便于前后端分离开发;
2、便于测试人员测试并检查数据;
3、加快新员工上手工作的速度;
4、后续工作交接。
然而,接口文档的整理与编写又令繁重的开发工作雪上加霜。有没有好用的工具或者api可以简化这些工作呢?答案是肯定的,这也是我们今天要介绍的Swagger。
1、先看一下swagger的原理
在本项目中是基于springboo基础上的。
1、系统启动,扫描到工程中的Swagger2Configuration类
(1)在启动类上加上包扫描
(2)在Swagger2Configuration.java类中也要配置包扫描位置
在这里配置的basePackage()中填写的包路径必须要包含配置类所在的包路径或者父包。
2、找到在此包下及子包下标记有@ResController注解的controller类所调用的接口
3、根据接口中的api注解进行生成在线接口文档
结束。