Swagger教程

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_25814003/article/details/81710222

Swagger搭建Restful接口教程一

一、前言

       Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件,随着现在许多公司实现了前后端分离,swagger越来越受欢迎了。

       博主之前在网上查看相关博客的时候,发现这些博客说的都不是很清楚,更有甚者连版本都弄错了,明明不能实现,访问量还挺多的,表示很无奈。为了帮助大家,特意抽时间系统性的整理了下有关知识。

       本次知识点有两篇博客,如果大家觉得不错,欢迎点赞,留言评论。

       最近一段时间,因为公司项目比较赶,确实比较忙,所以本来打算7月初给大家分享这个干货的,一直拖到了现在,实在抱歉。

       PS文章底部是我的代码下载链接,大家可以自行下载。

 

二、历史版本(绝版干货)

       其实swagger是有两个版本的,而且区别还挺大的,一个是swagger-ui也就是swagger1;还有一个是springfox-swagger也就是swagger2;很多人都不知道给搞混淆了,两个版本各有各得特色,本篇博客先说swagger-ui。

 

三、版本一(swagger-ui)

效果展示

       通过输入http://localhost:8080/项目跟路径/dist/index.html直接可以访问自己的页面。

       我的是http://localhost:8080/swagger_springmvc/dist/index.html#/

 

四、准备工作

前端HTML下载

  下载dist文件

  1. swagger-ui版本首先需下载HTML有两种方式
  2. 第一种:从github上下载相关html  ,;

https://github.com/swagger-api/swagger-ui

 

  1. 第二种:就是从我的博客底部分享的下载地址中下载已经弄好了不过需要积分哈哈(ps 虽然我不想要积分,但是csdn强制规定要,很烦)

注意事项

如果采取第一种下载方式的话,一定要注意版本,千万不要下载最新的版本dist否则swagger-ui是不支持的。要下载2.x版本的。

详细地址:https://github.com/swagger-api/swagger-ui/tree/2.x/dist

个人建议还是从我的博客中下载吧,毕竟我已经都给弄好了。

Jar包下载

 

<!-- Swagger -->

          swagger-springmvc 1.0.2

          swagger-models 1.0.2

          swagger-annotations 1.3.11

 

<!-- JSON -->

          json-lib 2.4

 

<!-- JACKSON -->

          jackson-annotations 2.6.5

          jackson-databind 2.6.5

          jackson-core 2.6.5

 

       大家可以自行去下载,或者从我的博客下载链接下载。

注意事项

       这些jar包的版本不能改变,如果版本改了很可能因为版本的原因而实现不了,说个最简单的Swagger jar 版本如果变了,很大可能就不行,这个之前博主亲自试验过。

      如果你的项目是maven项目的话,那么给的建议就是将这些jar包配到自己的maven仓库。然后再pom文件里引入,就像我的这样。

当然你也可以直接add引入,个人建议还是放在pom里比较规范。

 

五、代码实现

jar包引入。

        要引入的jar包(第三章)之前就说了。

 

前端dist文件引入

        将下载的dist文件拷贝到webapp目录下。(我用的是myeclipse,不同的软件名字可能不一样)

                                 .

 

       在dist文件夹下的index.html文件中修改url将之修改成为你项目swagger的url url命名规范是 IP+端口号+项目根路径(如果你项目有根路径的话)+api-docs

注意事项

        url后的 api-docs是固定的

 

 

Config配置

新建config文件夹,在文件中新建swagger.java文件,配置启动相关信息。

 

 

 

然后再配置文件中引入本文件

 

Controller注解

控制层可以有两种方式展现根据大家喜好来。

方式一

方式二

 

两种方式都可以 看大家喜欢那种写法。

六、成果展现

访问

         启动项目 访问地址

        地址是 IP + 端口号 +项目跟路径 + / dist/index.html#/

        我的是http://localhost:8080/swagger_springmvc/dist/index.html#/ 后缀是固定的 不要改变

 

七、备注赠言

1.本篇博客主要是讲swagger1实现restful风格大家千万别弄错包了。

2.可以去我的博客链接下载jar包,和相关项目

3.如果项目启动不起来,很正常啊,因为你得把项目换成你自己的数据库,表也得换成你自己的

 

 

八、下载地址

Jar包,项目demo,等我都已经上传了,大家可直接下载使用。

download:https://download.csdn.net/download/qq_25814003/10606548

 

阅读更多

没有更多推荐了,返回首页