swagger
swagger搭建Restful接口教程二
一、前言
上一章节我们说的是swagger-ui也就是swagger1,接下来我们说的是swagger升级版swagger2
Swagger是当前最好用的Restful API文档生成的开源项目,随着swagger的越来越流行,原来需要有人把dist封装成jar,与Spring相关框架结合,也就成了springfox-swagger
如果大家觉得不错,欢迎点赞,留言评论。
二、历史版本(绝版干货)
其实swagger是有两个版本的,而且区别还挺大的,一个是swagger-ui也就是swagger1;还有一个是springfox-swagger也就是swagger2;很多人都不知道给搞混淆了,两个版本各有各得特色,本篇博客说springfox-swagger。
三、版本二(springfox-swagger(swagger2))
效果展示
通过输入http://localhost:8080/项目跟路径/swagger-ui.html直接可以访问自己的页面。我的是http://localhost:8080/springfox_springmvc/swagger-ui.html
因为页面是封装好的,所以后缀swagger-ui.html是不变的
三、准备工作
Jar包下载
<!-- Swagger包 -->
springfox-core-2.6.1
springfox-schema-2.6.1
springfox-spi-2.6.1
springfox-spring-web-2.6.1
springfox-swagger2-2.6.1
springfox-swagger-common-2.6.1
springfox-swagger-ui-2.6.1
swagger-models-1.5.10
swagger-annotations-1.5.10
spring-plugin-metadata-1.2.0.RElease
spring-plugin-core-1.2.0.RELEASE
classmate-1.2.0
guava-18.0
<!-- JSON包 -->
json-lib-2.4-jdk15
json-lib-2.4-sources
<!-- jackson包 -->
jackson-annotations 2.6.5
jackson-databind 2.6.5
jackson-core 2.6.5
大家可以自行去下载,或者从我的博客下载链接下载,因为好多是封装好的,所以jar可能比较多。
注意事项
这些jar包的版本不能改变,如果版本改了很可能因为版本的原因而实现不了,说个最简单的Swagger jar包版本如果变了,很大可能就不行,这个之前博主亲自试验过。
如果你的项目是maven项目的话,那么给的建议就是将这些jar包配到自己的maven仓库。然后再pom文件里引入,就像我的这样。
当然你也可以直接add引入,个人建议还是放在pom里比较规范。
以上图片是我引入的jar 直接复制就行。
四、代码实现
jar包引入。
要引入的jar包(第三章)之前就说了。
Config配置
新建config文件夹,在文件中新建SwaggerConfigFirst.java文件,配置启动相关信息。
然后再配置文件中引入本文件
这个SwaggerConFirst类有四个注解,看名称就可以明白是什么意思。其中,@configuration,@EnableWebMvc和@componentScan是Spring的注解,而@EnableSwagger2则是用来启动Swagger支持,表示这是一个Spring Swagger的配置文件。
之后,定义了一个Bean方法CustomDocket,Spring中名字并不重要,重要的是它返回一个Docket类,DocumentationType.SWAGGER_2作为Docket构造方法的参数,指定了所用的swagger版本2.0,官网上已经在预告3.0版本了。而之后的apiInfo则是调用接下来的apiInfo函数,来创建Docket的信息。apiInfo函数采用ApiInfobuilder来创建ApiInfo类。
controller注解
控制层可以有两种方式展现根据大家喜好来。
方式一
方式二
两种方式都可以 看大家喜欢那种写法。
五、成果展现
访问
启动项目 访问地址
地址是 IP + 端口号+项目跟路径+ /swagger-ui.html
我的是http://localhost:8080/springfox_springmvc/swagger-ui.html
后缀是固定的 不要改变
六、备注赠言
1.本篇博客主要是讲swagger2实现restful风格大家千万别弄错包了。
2.可以去我的博客链接下载jar包,和相关项目
3.如果项目启动不起来,很正常啊,因为你得把项目换成你自己的数据库,表也得换成你自己的
七、下载地址
Jar包,项目demo,等我都已经上传了,大家可直接下载使用。
download:https://download.csdn.net/download/qq_25814003/10622612
相关阅读
随着网络的发展,虚拟机越来越显得重要,常见的虚拟机有很多种,比如VMware,Vbox等,今天给大家带来VMware安装windows7教程。 准备工作 首
Excel作为常用办公软件之一,在数据处理方面能力大家有目共睹,相信经常处理表格的人对它的强大也深有体会。主要原因之一,在于它并不
软件评测师是“全国计算机技术与软件专业技术资格”中级认证,于2018年11月10号考试。 软件评测师教程有近700页。主要分为三大部分
iOS 11开发教程(二)编写第一个iOS 11应用 编写第一个iOS 11应用 本节将以一个iOS 11应用程序为例,为开发者讲解如何使用Xcode 9.0去
ROM制作工具使用介绍一、准备ROM包说明:本工具支持ROM卡刷包和线刷包,支持常规,dat和img格式的刷机包如果找不到ROM,也可以 选择线上