Swagger工程化实践

1、从零开始新增API

1.1、编写Swagger API并保存为api.yaml到本地

打开Swagger editor API文档编辑工具(通过单击下面社区链接)
社区:https://editor.swagger.io
API编写规范参照:Open API规范(https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

1.2、下载swagger-codegen-cli.jar

地址:https://github.com/XiaotaoYi/spring/blob/master/spring-boot-swagger/swagger-codegen-cli.jar

1.3、准备api-codegen-config.json

image.png

使用: https://github.com/XiaotaoYi/spring/blob/master/spring-boot-swagger/api-codegen-config.json

文件中的参数值需要改变。

apiPackage:生成Controller的完整包名。

groupId:maven项目的groupId。

artifactId:maven项目的artifactId。

artifactVersion:maven项目的版本。

modelPackage:生成API返回模型的完整包名。

basePackage:项目的包名。

configPackage:生成配置类的完整包名。

1.4、用命令生成初始项目

java -jar swagger-codegen-cli.jar generate -i api.yaml -l spring -o example -c api-codegen-config.json

其中:-o 为output path

2、基于已有工程修改API

2.1 打开Swagger editor API文档编辑工具(通过单击下面链接)

社区:https://editor.swagger.io/

2.2 从工程中复制API定义到swagger editor中(复制如图api.yaml中内容)

image.png

2.3 编辑API文档

参照项:

1)已有API定义

2)Open API规范(https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

2.4 使用新的API定义去覆盖项目api.yaml

2.5 在Run/Debug Configuration窗口中新建或编辑一个如下图的Maven配置,并启动

image.png

重要说明:

1)使用spring-boot:run命令行去启动spring boot 程序(这样会自动根据API.yaml生成新的API接口代码,保持开发基于最新代码

2)启动过程中,会自动根据API.yaml生成新的API接口代码(包括接口类或模型)

3)接口类和模型不能被手工添加和修改,只能靠swagger-codegen-maven-plugin自动生成

4)Fix相应编译错误(可能API实现类需要根据新的API进行改写)

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