eclipse maven项目 class类部署不到tomcat下_项目集成Swagger2构建RESTful API文档(一)

前期准备

开发工具:IntelliJ IDEA;JDK版本:1.8.0_91;
b3b67724a9c5a99ad19f2f3181ad82ad.png

工具不一定非得idea,也可以是eclipse/myeclipse等都可

bcd46e326272cabf07c41339f0bcb175.png

注意:spring boot 2.x要求最低Java8支撑


通过 https://start.spring.io 快速构建spring boot项目(Maven)

构建网址:   https://start.spring.io/
3c025d02b1d2af251f4f14d57e727d2a.png
4bc34648ff9a12344d737f22c821e5ab.png
07119a45523eefc02865920d32a6c304.png

项目导入idea

c81652984893a81a27f8abaee4818d7d.png
0a1fd33694e8d58fbba015eb08148e53.png

配置项目

b492ed67a9e70fe37ee4548907689b8e.png
77dccfd44fe62b455ff9c2d6f864a691.png

使用热部署,修改页面信息才能及时显示出来

84627aaed5cf8da80cee6e2078880d48.png
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
af64c8d1529dff72ebbb8a798e3ac9b9.png
c81174ac2632ee3eaccecca0574ab8df.png
5aee4b07307dd1815e04b9456b4fa909.png

创建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) // 根据包路径扫描接口
188fe70315b69dbe3c8e7fb8a2d92265.png

结合成功,RESTful风格的接口


如何将本地已经存在的项目提交到GitHub上

  • 首先在GitHub上创建一个项目地址
6cf0da557ee726b1b0cd2f73e90e0206.png
  • 通过本地开发工具提交项目到GitHub上
ae7f198bc40b08f3096fe3744c532c0b.png

步骤一:git init

72450fc2dece296972b259d1d343be79.png

步骤二:git add .

7781b306ee345ff62d778db5b37f1629.png

步骤三:git commit -m '备注内容'

74b349b3ae77826a24897f34c05d8d8e.png

步骤四:git remote add origin https://github.com/thensunboy/swagger2.git

3746840cde28caf020e15978d01dc4bf.png

步骤五:git push -u origin master


至此,spring boot项目集成REST ful 风格的接口就算完成了。以上仅限于个的水平理解整理,如有不足之处望多多提出更好的建议。希望对初学者(入门者)提供一定的帮助。

有任何问题可留言,我们共同探讨,共同进步。

附项目GitHub源码地址:https://github.com/thensunboy/swagger2.git

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值