前期准备
开发工具:IntelliJ IDEA;JDK版本:1.8.0_91;
通过 https://start.spring.io 快速构建spring boot项目(Maven)
构建网址: https://start.spring.io/
项目导入idea
配置项目
war和war exploded的区别: 1、war模式这种可以称之为是发布模式,就是先将WEB工程打成war包,然后再将其上传到服务器进行发布. 2、 war exploded模式是将WEB工程以当前文件夹的位置关系上传到服务器,即直接把文件夹、jsp页面 、classes等等移到Tomcat 部署文件夹里面,进行加载部署。因此这种方式支持热部署,一般在开发的时候也是用这种方式
添加Swagger2依赖(https://mvnrepository.com/)
既然我们使用的是maven管理,那么相关依赖我们都可以在maven依赖库中进行查找并引入(版本根据需要可自行选择)。
springfox-swagger2:https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui/2.3.1springfox-swagger-ui:https://mvnrepository.com/artifact/io.springfox/springfox-swagger2/2.3.1
创建Swagger2配置类
- SwaggerAPI注解详解,以及注解常用参数配置
@Api:作用在类上,用来标注该类具体实现内容。表示标识这个类是swagger的资源 。参数:1. tags:可以使用tags()允许您为操作设置多个标签的属性,而不是使用该属性。2. description:可描述描述该类作用。
RequestHandlerSelectors扫描配置:
- any() // 扫描所有,项目中的所有接口都会被扫描到
- none() // 不扫描接口
- withMethodAnnotation(final Class extends Annotation> annotation)// 通过方法上的注解扫描,如withMethodAnnotation(GetMapping.class)只扫描get请求
- withClassAnnotation(final Class extends Annotation> annotation) // 通过类上的注解扫描,如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
- basePackage(final String basePackage) // 根据包路径扫描接口
如何将本地已经存在的项目提交到GitHub上
- 首先在GitHub上创建一个项目地址
- 通过本地开发工具提交项目到GitHub上
至此,spring boot项目集成REST ful 风格的接口就算完成了。以上仅限于个的水平理解整理,如有不足之处望多多提出更好的建议。希望对初学者(入门者)提供一定的帮助。
有任何问题可留言,我们共同探讨,共同进步。
附项目GitHub源码地址:https://github.com/thensunboy/swagger2.git