Spring boot+Swagger配置无侵入式Restful接口(一)

最近一直遇到有人问我spring boot +swagger怎么配置无侵入式的restful接口,这段时间一直很忙,没有时间,刚好星期六,趁着休息时间给大家写个demo,在这里我就粘贴一些步骤,具体的源码我就上传到码云上面吧,在这里我使用的工具是IDEA,大家可以搜搜了解下,蛮不错的一个IDE

1.创建一个初始化,在这里为了节约基础的配置我就选spring initalizr,idea在2014就已经支持了,选择下一步,然后进行一系列选择


2.为了快速,我就不选数据库那些,只选择一个web,如果需要数据库的话,无论是关系型数据库还是非关系型数据库,支持得都还好

3.项目基础结构如下,因为自带有maven的操作,我就把这边的文件删除掉


4.添加swagger的依赖,其实页面返回的时候是json格式,还需要添加jackson的依赖,只是spring boot默认关系依赖就将jackson添加进来了



5.配置swagger


6.编写测试controller,这里我们不需要对里面的controller和方法进行swagger配置,swagger会自动扫描所有的controller,如果没有指定是请求的哪种方法,就会将七种(get,post,put,delete等等)都进行展示,如果设置了特定的请求方法,就只会展示特定的请求方法.


7.由于我其他地方使用了8080端口,所以我就使用80端口,一句话搞定,是不是特别简单,因为springboot默认集成了tomcat等容器,至于支持的版本,可以搜下官网的说明文档,要不就把tomcat升级到8.0以上,要么就手动配置tomcat的版本


8.开始运行,先clean,再package,然后再plugins里面spring-boot找到run,就可以运行了,如果你是java源文件,也可以直接找到主方法的类,run一下就okay


9.打开浏览器开始访问啦 http://localhost:端口号/swagger-ui.html,我的访问地址就是http://localhost/swagger-ui.html


10.如果正式运行项目,注释或者去掉swagger的配置和去掉对swagger的依赖即可

11.如果大家用的是spring mvc的框架的话,我后面有时间就给写个demo吧,其实原理也差不多,只是多个jackson的依赖,大家可以尝试一下

12.源代码我已上传至码云,链接地址spring boot+swagger,欢迎大家下载和交流,如果本文章有什么错误的地方,欢迎大家指出,谢谢!

13.如果你觉得这个还是太过麻烦了,接下来,是时候来一波大招了,  Spring boot+Swagger配置无侵入式Restful接口(二)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,302评论 5 470
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,232评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,337评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,977评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,920评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,194评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,638评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,319评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,455评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,379评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,426评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,106评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,696评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,786评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,996评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,467评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,043评论 2 341

推荐阅读更多精彩内容