Swaggr 使用帮助

官网:http://swagger.io/

Annotations文档:
https://github.com/swagger-api/swagger-core/wiki/Annotations
编写API规格文档:http://swagger.io/specification/
开源集成:http://swagger.io/open-source-integrations/
在线编辑:http://editor.swagger.io/#!/

正常开发流程:
通过在线编辑工具编辑API,然后导出服务端和客户端代码进行开发。

swagger+spring boot

如果是spring mvc集合,则使用springfox,官网Demo,如果使用Restlet API and JAX-API,则使用restlet-framework

参考文章:
官网博客:https://www.easyitblog.info/2017/01/08/api-first-approach-with-swagger/
其他博客:
http://www.cnblogs.com/java-zhao/p/5348113.html
https://juejin.im/entry/580457030bd1d0005812a700
http://www.cnblogs.com/woshimrf/p/5863318.html

编写Controller注意事项

  1. 入参最好使用Spring MVC提供的注解:@RequestBody,@RequestParam,@PathVariable,取代使用HttpServletRequest request.getParamter()的方式,因为使用request.getParamter这种方式获取参数时,swagger无法自动解析出入参对象。
  2. 如果Controller入参为对象,不加@RequestBody和加上@RequestBody的区别:
    Paste_Image.png

    打开swagger-ui:
    添加有@RequestBody注解的入参为一个json串对象:
    添加有RequestBody注解

    没有RequestBody注解的为不同的字段:
    没有RequestBody注解
  3. 出参尽量使用@ResponseBody或者RespinseEntity对象。区别:ResponseEntity可以包含Header和HttpStatus。
  4. 入参使用注解时,根据是否必填修改requested值。

swagger常用路径

  1. swaggerUI路径:http://localhost:8080/swagger-ui.html
  2. swagger API路径查看:http://localhost:8080/swagger-resources
    Paste_Image.png
  3. swagger API 说明文件查看。根据2结果,查询对应api的json,例如查询full-demo-api,这它对应的location为/v2/api-docs?group=full-demo-api,这路径为:http://localhost:8080/v2/api-docs?group=full-demo-api

使用现有Controller生成客户端文件

首先通过swagger UI查询出该API对应的json说明文件,方式为上面“swagger常用路径”第3个,例如为:http://localhost:8080/v2/api-docs?group=full-demo-api, 浏览器中打开:

full-demo-api

复制结果,打开swagger editor,选择File-->Paste JSON,将内容复制进去点击Import。

Paste_Image.png

然后选择GenerateServer或GenerateClient选择对应的语言下载即可,可以下载为HTML

Paste_Image.png

swagger转为HTML 和 PDF文档

请查看:http://www.jianshu.com/p/0aa7c915ee9e

Eclipse插件:RepreZen API Studio(收费,可以试用14天)
官网:http://www.reprezen.com/Swagger-Tools
已经上架Eclipse Marketplace

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,571评论 25 707
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,368评论 6 343
  • Spring的模型-视图-控制器(MVC)框架是围绕一个DispatcherServlet来设计的,这个Servl...
    alexpdh阅读 2,603评论 0 3
  • 今天又差不多在宿舍窝了一天,哎。。。被舍友拉着打游戏,堕落啊,感觉又有些玩腻了。 今天晚上本来要去排练的,...
    永恒yxh阅读 103评论 0 0