组件分享之后端组件——一个Go 的 Swagger 2.0 实现组件go-swagger

组件分享之后端组件——一个Go 的 Swagger 2.0 实现组件go-swagger

背景

近期正在探索前端、后端、系统端各类常用组件与工具,对其一些常见的组件进行再次整理一下,形成标准化组件专题,后续该专题将包含各类语言中的一些常用组件。欢迎大家进行持续关注。

组件基本信息

内容

本节我们分享一个Go 的 Swagger 2.0 实现组件go-swagger

特征

go-swagger为 Go 社区带来了一整套功能齐全、高性能的 API 组件,可与 Swagger API 一起使用:服务器、客户端和数据模型。

  • 从 swagger 规范生成服务器
  • 从 swagger 规范生成客户端
  • 从 swagger 规范(alpha 阶段)生成 CLI(命令行工具)
  • 支持 jsonschema 和 swagger 提供的大部分功能,包括多态性
  • 从带注释的 go 代码生成一个 swagger 规范
  • 使用 swagger 规范的其他工具
  • 强大的自定义功能,带有供应商扩展和可自定义的模板
    我们的代码生成重点是生成惯用的、快速的代码,它与 golint、go vet 等配合得很好。

功能描述

  • 序列化兼容 swagger 的 yaml 或 json 的对象模型
  • 使用 swagger 的工具
    • 为任何 swagger 规范文件提供 swagger UI
    • 灵活的代码生成,带有可定制的模板
      • 基于 swagger 规范生成 go API server
      • 从 swagger 规范生成 go API 客户端
    • 验证一个招摇的规范文档,这里列出了额外的规则
    • 根据带注释的代码生成规范文档
  • 使用 Rest API 和中间件的运行时
    • 服务规格
    • 路由
    • 验证
    • 授权
    • Swagger 文档用户界面
    • 如果规范中的更改破坏了向后兼容性,则会导致构建失败的 Diff 工具

还有更多...

  • 一个类型化的 JSON Schema 实现,支持 Draft 4 的大部分特性
  • 扩展字符串和数字格式:strfmt
  • 使用 JSON、转换数据类型和指针的实用程序:swag
  • 一个 jsonschema (Draft 4) 验证器,具有完整的 $ref 支持:validate
  • 自定义验证界面
本文声明:

88x31.png

知识共享许可协议
本作品由 cn華少 采用 知识共享署名-非商业性使用 4.0 国际许可协议 进行许可。

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

推荐阅读更多精彩内容