基于Swagger的RESTful API开发之工具篇

基于Swagger的RESTful API开发之工具篇

一、数据模型设计(docson)

数据模型设计采用docson + Typson + TpyeScript.
其中,TpyeScript是一个javascript超集。
Typson是利用TpyeScript语言编程代码生成JSON Schema的工具。
docson是通过json schema生成对应的在线JSON可视化文档的工具。

typson-demo是一个整合好在线编辑工具。可以通过http://hi104.github.io/types cript-playground-on-ace/ 在线体验。

使用方法

  1. 安装typson-demo,实际上这只是一个web项目,将它放在任何一个web服务器容器中中启动服务器,在浏览器中访问即可,例如我使用的是tomacat服务器,将typson-demo项目下载下来被解压后(文件夹名称是typson-demo-gh-pages)放在tomcat的webapps目录中,启动服务器访问http://localhost:8081/typson-demo-gh-pages/index.html 即可。这一步在注意typson-demo项目文件夹里没有放docson 和 Typson 相关的js,因此需要自己下载docson + Typson放入文件夹中。

  2. 在typson-demo可视化的完成数据模型设计

  3. 将完成的TpyeScript保存到一个ts文件中,使用typson对ts文件进行转换,生成JSON schema文件

二、API接口设计

分两步完成API接口设计

使用SWAGGER EDITOR工具在线可视化编辑API

这个工具有在线版的:http://editor.swagger.io/#/
也可以下载使用离线版本。具体可以参考 http://swagger.io/swagger-editor/ 中的介绍
在安装的时候发现github上没有dist文件,需要自己从http://editor.swagger.io/#/ 上面去扒下来。

使用的是yml文件语法。

使用swagger-ui生成API文档

这里使用 SWAGGER UI 进行文档生成。工具地址是 http://swagger.io/swagger-ui/
这个工具也有在线版和离线版本,由于要访问上个步骤生成的JSON文件,建议下载离线版本在本地部署使用。
这里提醒一下,swagger-ui下载下来的zip包中dist目录才是项目可以运行的目录。

  1. 在上一步完成接口设计后,使用File -> JSON生成JSON文件。
  2. 将json文件放置在SWAGGER UI可以访问到的地址,在http://localhost:8081/swagger-ui/dist/ 页投输入资源的URL地址,回车或点击Explore即可看到API文档,并且可以在上面做测试。

三、工程测试

使用swagger-codegen可以根据接口生成测试时使用的客户端或服务端的测试代码,方便前后端分离进行开发。

这一块还要具体使用下再说明,下次再补充。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,071评论 25 707
  • Swift版本点击这里欢迎加入QQ群交流: 594119878最新更新日期:18-09-17 About A cu...
    ylgwhyh阅读 25,365评论 7 249
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,093评论 4 62
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • 今天发现简书,很是激动,哪颗写作的心瞬间被点醒,这里有好多大咖,希望自己在这里学习更多的知识,也希望自己也可以写...
    那些三月花阅读 201评论 0 0